介绍每个接口都需要使用的请求参数和返回参数。
公共请求参数
公共请求参数是指每个接口都需要使用到的请求参数。
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Action | String | 是 | API的名称。 |
Format | String | 否 | 返回值的类型,支持JSON与XML。默认为XML。 |
Version | String | 是 | API版本号,为日期形式:YYYY-MM-DD,本版本对应为2017-12-14。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥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 | 是 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。 |
示例
http://business.aliyuncs.com/?SubscriptionType=Subscription
&Format=XML
&SignatureMethod=HMAC-SHA1
&Signature=AAAAAAAAAAAAAAAAAA%3D
&Timestamp=2018-01-18T10%3A57%3A00Z
&AccessKeyId=BBBBBBBBBBBBBBB
&Action=QueryMonthlyBill
&SignatureNonce=CCCCCCCCCCCCCCCC
&Version=2017-12-14
&SignatureVersion=1.0
&BillingCycle=2018-01
公共返回参数
用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码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", /*返回结果数据*/ }