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

公共请求参数

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

名称 类型 是否必选 描述
Format String 返回值的类型,支持JSON与XML。默认为XML。
Version String OpenAPI版本号,为日期形式:YYYY-MM-DD,本版本对应为 2018-11-11
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。
Signature String 签名结果串,关于签名的计算方法,请参见签名机制
SignatureMethod String 签名方式,目前支持 HMAC-SHA1
Timestamp String 请求的时间戳。日期格式按照 ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ,例如,2014-05-26T12:00:00Z(为北京时间 2014年5月26日20点0分0秒)。
SignatureVersion String 签名算法版本,目前版本是 1.0
SignatureNonce String 唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值
ResourceOwnerAccount String 本次OpenAPI请求访问到的资源拥有者账户,即登录用户名。 此参数的使用方法,详见借助RAM实现子账号对主账号的资源访问 (只能在RAM中可对ECS资源进行授权的 Action中才能使用此参数,否则访问会被拒绝)。

公共请求参数示例

https://foas.aliyuncs.com/
?Format=xml
&Version=2018-11-11
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&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-AC049166F216</RequestId>
    <!--返回结果数据-->
    </接口名称+Response>
  • JSON示例
    {
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* 返回结果数据 */
    }