公共参数

公共请求参数

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

名称 类型 是否必须 描述
Format String 否 返回值的类型，支持 JSON 与 XML。默认为 XML。
Version String 是 API 版本号，为日期形式：YYYY-MM-DD，本版本对应为2016-05-11。
AccessKeyId String 是 阿里云颁发给用户的访问服务所用的密钥 ID。
Signature String 是 签名结果串，关于签名的计算方法，请参见签名机制。
SignatureMethod String 是 签名方式，目前支持 HMAC-SHA1。
Timestamp String 是 请求的时间戳。日期格式按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为YYYY-MM-DDThh:mm:ssZ，例如，2015-01-09T12:00:00Z（为 UTC 时间 2015 年 1 月 9 日 12 点 0 分 0 秒。）
SignatureVersion String 是 签名算法版本，目前版本是 1.0。
SignatureNonce String 是 唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。

示例

  1. https://domain.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2016-05-11    
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D     
  5. &SignatureMethod=HMAC-SHA1    
  6. &SignatureNonce=15215528852396   
  7. &SignatureVersion=1.0   
  8. &AccessKeyId=key-test   
  9. &Timestamp=2016-05-11T12:00:00Z   
  10. …

公共返回参数

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

XML 示例

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

JSON 示例

  1. {
  2.     "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3.     /* 返回结果数据 */
  4. }