admin 管理员组文章数量: 1087139
2024年3月22日发(作者：html5进度条)
天翼云主机类API接口技术规范
一、文档说明
API详细设计说明文档主要为省公司API对接提供接口的详细功能描述。其中包括对API的功能描述、字
段元素描述；调用参数的定义及说明；响应参数的元素说明及响应样例；API调用地址和API交互方式等功能。
二、基础说明
1. 返回值状态码说明
为简化接口调用的复杂程度，接口仅会返回两种状态码：响应成功返回状态码800，响应失败返回状态
码900。针对接口调用参数不正确（如少参数、参数位置不正确或请求方式不正确）时，系统将直接返回400；
对于正确的调用但执行错误时，返回值中将包含中文的错误提示。
2. 名词解释
名词
真实资源ID
虚拟资源ID
crmBizId
说明
用于对订购的资源进行管理的唯一标识，如开机、关机等操作
用于对资源进行订购类操作的唯一标识，如续订、退订等
省公司用户下单时必须传bizId，且该bizId必须是已经推送成功并已绑定真实邮箱的客
户账号
3. 公共参数说明
本文档中所有的API接口在调用时需要提供两类参数：公共参数和业务参数。其中前者用于保证API的
调用安全；后者则包含了执行业务所需的数据。下面表格中展示了公共参数的名称及说明，业务参数将在具
体的API接口中进行说明。对于调用接口所涉及的算法，请参看附录四（目前只提供了Java版本）。
参数说明中，有些值在不明确的情况下，使用了“xxxxxx”代替，调用时需要使用实际的值。当接口的
返回值或参数过长时，使用了嵌入式文本进行了说明与注释。测试调用时要去除相关的注释文本。
4. 传参位置说明
接口的调用目前包括两种方式：POST和GET，其中涉及到数据修改的接口一般使用POST方式；涉及到
查询的接口一般使用GET方式。对于参数的存放位置包括两种：POST方式，业务参数放至HTTP请求的BODY
中；GET方式，业务参数放至HTTP请求的HEADER中。所有的公共参数不管接口的请求方式是POST或是GET，
均放置HEADER中。
参数名
accessKey
contentMD5
选项
*必填
*必填
参数位置
HEADER
HEADER
说明
天翼云分配给用户的公钥
业务参数值的MD5摘要：paraN-1nparaN
contentMD5的加密方式：
contentMD5内容为业务参数的MD5信息摘要，构成MD5原始信
息格式为（参数的拼接顺序以API签名为准，错误的顺序将导致验
证失败）：paraN-1nparaN，即将每个业务参数通
过字符“n”进行连接。若所调用的接口没有参数直接传空字符串
“”进行转换为md5
requestDate
hmac
*必填
*必填
HEADER
HEADER
“EEE, d MMM yyyy HH:mm:ss z”格式的请求日期（只接收英文格式）
使用HMAC算法生成的信息摘要。
HMAC原始信息中需要的字段：
使用HMAC加密码时需要密钥和待加密的消息两部分内容。所以，
系统中使用secretKey（用户密钥）作为加密密钥，待加密的消息由
下面三部分构成：contentMD5，requestDate，servicePath（REST服
务名称，例如“/apiproxy/v3/order/cancelOrder”），三部分信息通
过“n”进行连接（要注意连接的顺序）：
contentMD5nrequestDatenservicePath。
platform
*必填
HEADER
平台类型，整数类型，取值范围：2或3，传2表示2.0自营资源，
传3表示3.0合营资源，该参数不需要加密。
customInfo参数的json串详细信息：
版权声明：本文标题：天翼云主机类API接口技术规范 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://roclinux.cn/p/1711088803a587843.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论