公共請求參數

公共請求參數是每個介面都需要使用到的請求參數。

表 1. 公共請求參數表
名稱 類型 是否必須 描述
Format String 返回消息的格式。取值:

JSON (預設值) | XML

Version String API版本號碼,使用YYYY-MM-DD日期格式。取值:

2014-05-15

AccessKeyId String 訪問服務使用的密鑰ID。
Signature String 簽名結果串。
SignatureMethod String 簽名方式,取值:

HMAC-SHA1

Timestamp String 請求的時間戳記,為日期格式。使用UTC時間按照 ISO8601標,格式為YYYY-MM-DDThh:mm:ssZ。

例如,北京時間2013年1月10日20點0分0秒,表示為2013-01-10T12:00:00Z。

SignatureVersion String 簽名演算法版本,取值:

1.0

SignatureNonce String 唯一隨機數,用於防止網路重放攻擊。

在不同請求間要使用不同的隨機數值。

ResourceOwnerAccount String 本次API請求訪問到的資源擁有者賬戶,即登入使用者名。
樣本
http://slb.aliyuncs.com/?Action=DescribeLoadBalancers
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2014-05-15
&SignatureVersion=1.0
&Signature=Signature

公共返回參數

API返回結果採用統一格式,返回2xx HTTP狀態碼代表調用成功;返回4xx或5xx HTTP狀態碼代表調用失敗。調用成功返回的資料格式有XML和JSON兩種,可以在發送請求時指定返回的資料格式,預設為XML格式。

每次介面調用,無論成功與否,系統都會返回一個唯一識別碼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",
        /*返回結果資料*/
        }