本文档介绍API接口使用的公共请求参数。

公共请求参数

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

表 1. 公共请求参数表
名称 类型 是否必须 描述
Format string 返回消息的格式。

取值:JSON (默认值) | XML

Version String API版本号,使用YYYY-MM-DD日期格式。

取值:2017-11-29

AccessKeyId String 访问服务使用的密钥ID。
Signature String 签名结果串。
SignatureMethod String 签名方式。

取值:HMAC-SHA1

Timestamp String 请求的时间戳,为日期格式。使用UTC时间按照 ISO8601标,格式为YYYY-MM-DDThh:mm:ssZ

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

SignatureVersion String 签名算法版本,目前版本是1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。

在不同请求间要使用不同的随机数值。

ResourceOwnerAccount String 本次API请求访问到的资源拥有者账户,即登录用户名。
示例
https://avds.aliyuncs.com/
?Format=xml
&Version=2017-11-29
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z

公共返回参数

API返回结果采用统一格式,返回2xx HTTP状态码代表调用成功;返回4xx或5xx HTTP状态码代表调用失败。

调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为XML格式。

每次接口调用,无论成功与否,系统都会返回一个唯一识别码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",
        /*返回结果数据*/
        }