公共参数是指每个接口都需要使用到的请求参数和返回参数。本文介绍 RPC 风格的 API 的请求参数和返回参数。

API 公共请求参数和公共返回参数如下:

说明 消息服务类 API 属于 ROA 风格,请公共参数请参见 公共参数

公共请求参数

名称 类型 是否必填 描述
Format String 返回值的类型,支持 JSON 与 XML。默认为 XML。
Version String API版本号,为日期形式(YYYY-MM-DD),轻量级虚商涉及系统API的版本号为:
  • 账号管理:
    • CreateAgAccount、GetCustomerAccountInfo 接口版本为 2017-12-14
    • GetCustomerList 接口版本为 2019-12-27
  • 实名认证:2015-04-08
  • 安全访问:2015-04-01
  • 预算管理:2017-12-14
  • 备案服务:2015-05-12
  • 工单服务:2016-06-18
AccessKeyId String 访问服务使用的密钥ID
说明 只有在调用 Assumerole 接口时该参数为虚商伙伴主账号的 RAM 子账号的密钥 ID。在调用其他接口时该参数为虚商伙伴主账号的密钥 ID。
Signature String 签名结果串,关于签名的计算方法,请参见签名机制
SignatureMethod String 签名方式,目前支持 HMAC-SHA1
Timestamp String 请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。

格式为:YYYY-MM-DDTHH:MM:SSZ。例如,2016-05-23T12:00:00Z(北京时间2016年5月23日20点0分0秒)

SignatureVersion String 签名算法版本,目前版本是1.0
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值
ResourceOwnerAccount String 本次 API 请求访问到的资源拥有者账户,即登录用户名。

示例

http://slb.aliyuncs.com/?Action=CreatAgAccount
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2014-05-15
&SignatureVersion=1.0
&Signature=abc*******123

公共返回参数

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