公共參數(shù)是指所有接口在調(diào)用時都需要用到的參數(shù)，包含公共請求參數(shù)和公共返回參數(shù)。

公共請求參數(shù)

名稱 類型 是否必選 描述
Format String 否 返回值的類型，支持JSON和XML，默認為XML。
Version String 是 OpenAPI版本號，版本號為日期格式：YYYY-MM-DD。當前版本號為2020-01-01。
AccessKeyID String 是 阿里云頒發(fā)給用戶的訪問服務所用的密鑰ID。
Signature String 是 簽名結(jié)果串。
SignatureMethod String 是 簽名方式，目前僅支持HMAC-SHA1。
Timestamp String 是 請求的時間戳，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
SignatureVersion String 是 簽名算法版本，目前版本為1.0。
SignatureNonce String 是 唯一隨機數(shù)，用于防止網(wǎng)絡重放攻擊。不同的請求需使用不同的隨機數(shù)值。

公共返回參數(shù)

用戶發(fā)送的每次接口調(diào)用請求，無論成功與否，系統(tǒng)都會返回一個唯一識別碼（RequestId）給用戶，可用來跟蹤請求的執(zhí)行情況。

返回示例

DTS OpenAPI使用標準的HTTP狀態(tài)碼表示請求處理的結(jié)果，具體狀態(tài)碼如下所示：

  • 返回的HTTP狀態(tài)碼為2xx，代表調(diào)用成功。
  • 返回的HTTP狀態(tài)碼為4xx或5xx，代表調(diào)用失敗。

數(shù)據(jù)格式主要有XML和JSON兩種，默認為XML格式，外部系統(tǒng)可以在請求時指定返回的數(shù)據(jù)格式。為便于查看，本文檔中的返回示例做了格式化處理，實際返回結(jié)果是沒有進行換行、縮進等處理的。

成功結(jié)果

  • XML示例 
    <?xml version="1.0" encoding="utf-8"?> 
<!—結(jié)果的根結(jié)點-->
<接口名稱+Response>
    <!—返回請求標簽-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!—返回結(jié)果數(shù)據(jù)-->
</接口名稱+Response>
  • JSON示例 
    {
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* 返回結(jié)果數(shù)據(jù) */
}

錯誤結(jié)果

調(diào)用出錯后，HTTP請求會返回一個4xx或5xx的HTTP狀態(tài)碼。返回的消息中包含具體的錯誤代碼及錯誤信息，還包含一個全局唯一的請求ID（RequestId）和一個本次請求訪問的站點ID（HostId）。

說明 您可以根據(jù)返回的錯誤碼來定位錯誤原因，詳情請參見錯誤碼。若您無法定位錯誤原因，請聯(lián)系阿里云客服人員，并提供調(diào)用出錯返回的HostId和RequestId，以便我們能盡快幫您解決問題。
  • XML示例 
    <?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dts.aliyuncs.com</HostId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>
  • JSON示例 
    {
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "dts.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}