公共參數是指每個接口都需要使用到的請求參數和返回參數。本文介紹 RPC 風格的 API 的請求參數和返回參數。

API 公共請求參數和公共返回參數如下：

說明 消息服務類 API 屬于 ROA 風格，請公共參數請參見公共參數。

公共請求參數

名稱 類型 是否必填 描述
Format String 否 返回值的類型，支持 JSON 與 XML。默認為 XML。
Version String 是 API版本號，為日期形式（YYYY-MM-DD），輕量級虛商涉及系統API的版本號為：
  • 賬號管理：
    • CreateAgAccount、GetCustomerAccountInfo 接口版本為 2017-12-14
    • GetCustomerList 接口版本為 2019-12-27
  • 實名認證：2015-04-08
  • 安全訪問：2015-04-01
  • 預算管理：2017-12-14
  • 備案服務：2015-05-12
  • 工單服務：2016-06-18
AccessKeyId String 是 訪問服務使用的密鑰ID
說明 只有在調用 Assumerole 接口時該參數為虛商伙伴主賬號的 RAM 子賬號的密鑰 ID。在調用其他接口時該參數為虛商伙伴主賬號的密鑰 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 是 唯一隨機數，用于防止網絡重放攻擊。用戶在不同請求間要使用不同的隨機數值
ResourceOwnerAccount String 否 本次 API 請求訪問到的資源擁有者賬戶，即登錄用戶名。

示例

http://slb.aliyuncs.com/?Action=CreatAgAccount
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2014-05-15
&SignatureVersion=1.0
&Signature=abc*******123

公共返回參數

API返回結果采用統一格式，調用成功返回的數據格式有XML和JSON兩種，可以在發送請求時指定返回的數據格式，默認為XML格式。每次接口調用，無論成功與否，系統都會返回一個唯一識別碼RequestId。
  • 返回2xxHTTP狀態碼表示調用成功。
  • 返回4xx或5xxHTTP狀態碼表示調用失敗。
公共返回參數示例如下：
  • XML格式 
    <?xml version="1.0" encoding="utf-8"?> 
    <!—結果的根結點-->
    <接口名稱+Response>
        <!—返回請求標簽-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!—返回結果數據-->
    </接口名稱+Response>
  • JSON格式 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*返回結果數據*/
}