公共参数
公共参数指的是所有接口调用都需要用到的参数,包含公共请求参数和公共返回参数两种。
公共请求参数
公共请求参数是指每个接口都需要使用到的请求参数。
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Format | String | 否 | 返回值的类型,支持 JSON 与 XML。默认为 XML。 |
Version | String | 是 | API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2018-05-01。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥 ID。 |
Signature | String | 是 | 签名结果串,关于签名的计算方法,请参见 签名机制。 |
SignatureMethod | String | 是 | 签名方式,目前支持 HMAC-SHA1。 |
Timestamp | String | 是 | 请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为: YYYY-MM-DDThh:mm:ssZ 例如,2014-05-26T12:00:00Z(为北京时间 2014 年 5 月 26 日 20 点 0 分 0 秒)。 |
SignatureVersion | String | 是 | 签名算法版本,目前版本是 1.0。 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值 |
示例
https://iovcc.[RegionId].aliyuncs.com/
?Format=xml
&Version=2018-05-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…
公共返回参数
用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户。
示例
XML
示例
<?xml version="1.0" encoding="UTF-8"?>
<!--结果的根结点-->
<接口名称+Response>
<!--返回请求标签-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--返回结果数据-->
</接口名称+Response>
JSON
示例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* 返回结果数据 */
}
文档内容是否对您有帮助?