公共请求参数
公共请求参数是指每个接口都需要使用到的请求参数。
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Format | String | 否 | 返回值的类型,支持JSON与XML。默认为XML |
Version | String | 是 | API版本号,为日期形式:YYYY-MM-DD ,本版本对应为2018-01-01 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥ID |
Signature | String | 是 | 签名结果串,关于签名的计算方法,请参见 签名机制。 |
SignatureMethod | String | 是 | 签名方式,目前支持HMAC-SHA1 |
Timestamp | String | 是 | 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ 例如,2018-01-01T12:00:00Z (为UTC时间2018年1月1日12点0分0秒) |
SignatureVersion | String | 是 | 签名算法版本,目前版本是1.0 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值 |
示例
https://pvtz.aliyuncs.com/
?Format=xml
&Version=2018-01-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-01-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"
/* 返回结果数据 */
}
文档内容是否对您有帮助?