本文介绍每个接口都需要使用的请求参数和返回参数。

公共请求参数

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

表 1. 公共请求参数表
名称 类型 是否必须 描述
Format String 否 返回值的类型，支持JSON与XML。默认为XML
Version String 是 API版本号，为日期形式：YYYY-MM-DD，本版本对应为2015-01-09。
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 是 唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。
示例 
https://alidns.aliyuncs.com/?Action=xxx
&Format=xml
&Version=2015-01-09
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2015-01-09T12:00:00Z
…

公共返回参数

API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码RequestId。
  • 返回2xxHTTP状态码表示调用成功。
  • 返回4xx或5xxHTTP状态码表示调用失败。
公共返回参数示例如下：
  • XML格式 
    <?xml version="1.0" encoding="utf-8"?> 
    <!—结果的根结点-->
    <接口名称+Response>
        <!—返回请求标签-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!—返回结果数据-->
    </接口名称+Response>
  • JSON格式 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*返回结果数据*/
    }