返回結果 - - 阿里雲

調用API服務後返回資料採用統一格式：

返回的 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。在調用方找不到錯誤原因時，可以聯絡阿里雲客服，並提供該 HostId 和 RequestId，以便我們儘快幫您解決問題。

XML樣本

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dm.aliyuncs.com</HostId>
   <Code>InvalidTemplate.NotFound</Code>
   <Message>The specified template does not found.</Message>
</Error>

JSON樣本

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "HostId": "dm.aliyuncs.com",
    "Code": "InvalidTemplate.NotFound",
    "Message": "The specified template does not found."
}