公用參數

公用請求參數

公用返回參數

使用者發送的每次介面調用請求，無論成功與否，系統都會返回一個唯一識別碼（RequestId）給使用者，可用來跟蹤請求的執行情況。

返回樣本

DTS OpenAPI使用標準的HTTP狀態代碼表示請求處理的結果，具體狀態代碼如下所示：

• 返回的HTTP狀態代碼為2xx，代表調用成功。
• 返回的HTTP狀態代碼為4xx或5xx，代表調用失敗。

資料格式主要有XML和JSON兩種，預設為XML格式，外部系統可以在請求時指定返回的資料格式。為便於查看，本文檔中的返回樣本做了格式化處理，實際返回結果是沒有進行換行、縮排等處理的。

成功結果

• XML樣本
  <?xml version="1.0" encoding="utf-8"?> 
  <!—結果的根結點-->
  <介面名稱+Response>
      <!—返回請求標籤-->
      <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
      <!—返回結果資料-->
  </介面名稱+Response>

• JSON樣本
  {
      "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
      /* 返回結果資料 */
  }

錯誤結果

調用出錯後，HTTP請求會返回一個4xx或5xx的HTTP狀態代碼。返回的訊息中包含具體的錯誤碼及錯誤資訊，還包含一個全域唯一的請求ID（RequestId）和一個本次請求訪問的網站ID（HostId）。

• 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."
  }