公共參數(shù)包括為公共請求參數(shù)和公共返回參數(shù)。

公共請求參數(shù)

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

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

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

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

HMAC-SHA1
Timestamp String 是 請求的時(shí)間戳，為日期格式。使用UTC時(shí)間按照ISO8601標(biāo)準(zhǔn)，格式為YYYY-MM-DDThh:mm:ssZ。

例如，北京時(shí)間2013年1月10日20點(diǎn)0分0秒表示為2013-01-10T12:00:00Z。
SignatureVersion String 是 簽名算法版本，取值：

1.0
SignatureNonce String 是 唯一隨機(jī)數(shù)，用于防止網(wǎng)絡(luò)重放攻擊。

在不同請求間要使用不同的隨機(jī)數(shù)值。

公共返回參數(shù)

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

每次調(diào)用接口，無論成功與否，系統(tǒng)都會返回一個(gè)唯一識別碼 RequestId。
  • XML格式 
    <?xml version="1.0" encoding="utf-8"?> 
    <!--結(jié)果的根結(jié)點(diǎn)-->
    <接口名稱+Response>
        <!--返回請求標(biāo)簽-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--返回結(jié)果數(shù)據(jù)-->
    </接口名稱+Response>
  • JSON格式 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    }