介紹每個接口都需要使用的請求參數和返回參數。
公共請求參數
公共請求參數是指每個接口都需要使用到的請求參數。
名稱 | 類型 | 是否必填 | 描述 |
---|---|---|---|
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", /*返回結果數據*/ }