公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。

表 1. 公共请求参数
名称 类型 是否必须 描述
Format String 返回值的类型,支持 JSON 与 XML。默认为 XML 。
Version String API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2014-08-15 。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥 ID 。
Signature String 签名结果串,关于签名的计算方法,请参见签名机制
SignatureMethod String 签名方式,目前支持 HMAC-SHA1。
Timestamp String
请求的时间戳。日期格式按照 ISO8601标准表示,并需要使用 UTC 时间。格式为:
YYYY-MM-DDThh:mm:ssZ

例如,2013-08-15T12:00:00Z为北京时间 2013 年 1 月 10 日 20 点 0 分 0 秒。

SignatureVersion String 签名算法版本,目前版本是 1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值 。

示例

https://gpdb.aliyuncs.com/ 
?Format=xml 
&Version=2013-08-15 
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D  
&SignatureMethod=HMAC-SHA1 
&SignatureNonce=15215528852396 
&SignatureVersion=1.0 
&AccessKeyId=key-test 
&Timestamp=2013-06-01T12:00:00Z

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId给用户。

示例:

<?xml version="1.0" encoding="utf-8"?>  
<!—结果的根结点--> 
<接口名称+Response> 
 <!—返回请求标签--> 
 <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> 
 <!—返回结果数据--> 
</接口名称+Response>