公共參數包括為公共請求參數和公共返回參數。

公共請求參數

公共請求參數是每個接口都需要使用到的請求參數，公共請求參數如下表所示。

名稱 類型 是否必須 描述
Format String 否 返回消息的格式。取值：

JSON（默認值）| XML
Version String 是 API版本號，使用YYYY-MM-DD日期格式。取值：

2016-04-28
AccessKeyId String 是 訪問服務使用的密鑰ID。
Signature String 是 簽名結果串。
SignatureMethod String 是 簽名方式，取值：

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

例如，北京時間2022年01月10日09點00分00秒表示為2022-01-10T01:00:00Z。
SignatureVersion String 是 簽名算法版本，取值：

1.0
SignatureNonce String 是 唯一隨機數，用于防止網絡重放攻擊。

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

公共返回參數

API返回結果采用統(tǒng)一格式，返回2xx HTTP狀態(tài)碼代表調用成功；返回4xx或5xx HTTP狀態(tài)碼代表調用失敗。調用成功返回的數據格式有XML和JSON兩種，可以在發(fā)送請求時指定返回的數據格式，默認為JSON格式。

每次調用接口，無論成功與否，系統(tǒng)都會返回一個唯一識別碼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",
    /*返回結果數據*/
}