公共参数是指所有接口在调用时都需要用到的参数,包含公共请求参数和公共返回参数。

公共请求参数

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

名称 类型 是否必选 描述
Format String 返回值的类型,支持JSON和XML,默认为XML。
Version String OpenAPI版本号,版本号为日期格式:YYYY-MM-DD。当前版本号为2018-08-01。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。
Signature String 签名结果串。
SignatureMethod String 签名方式,目前仅支持HMAC-SHA1。
Timestamp String 请求的时间戳,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
SignatureVersion String 签名算法版本,目前版本为1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。不同的请求需使用不同的随机数值。

请求示例

https://dms-enterprise.aliyuncs.com/?Action=ListUsers
&Format=xml
&Version=2018-11-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1******
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1521552885****
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…

公共返回参数

用户每次发送接口调用请求后,无论成功与否,系统都会返回一个唯一识别码RequestId,可用来跟踪该请求的执行情况。

正确返回示例如下:

  • XML示例
    <?xml version="1.0" encoding="UTF-8"?>
    <!--结果的根结点-->
    <接口名称+Response>
    <!--返回请求标签-->
    <RequestId>4C467B38-3910-447D-87BC-AC0491******</RequestId>
    <!--返回结果数据-->
    </接口名称+Response>
  • JSON示例
    {
    "RequestId": "4C467B38-3910-447D-87BC-AC0491******",
    /* 返回结果数据 */
    }