調用API服務后返回數(shù)據采用統(tǒng)一格式：

• 返回的 HTTP 狀態(tài)碼為 2xx，代表調用成功；

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

調用成功返回的數(shù)據格式主要有 XML 和 JSON 兩種，外部系統(tǒng)可以在請求時傳入參數(shù)來制定返回的數(shù)據格式，默認為 XML 格式。

成功結果

XML示例

<?xml version="1.0" encoding="UTF-8"?> 
<!-結果的根結點-->
<接口名稱+Response>
    <!-返回請求標簽-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!-返回結果數(shù)據-->
</接口名稱+Response>

JSON示例

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 返回結果數(shù)據 */
}

錯誤結果

調用接口出錯后，將不會返回結果數(shù)據。調用方可根據每個接口對應的錯誤碼以及 錯誤代碼表 來定位錯誤原因。

當調用出錯時，HTTP 請求返回一個 4xx 或 5xx 的 HTTP 狀態(tài)碼。返回的消息體中是具體的錯誤代碼及錯誤信息。另外還包含一個全局唯一的請求 ID：RequestId 和一個您該次請求訪問的站點 ID：HostId。在調用方找不到錯誤原因時，可以聯(lián)系阿里云客服，并提供該 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."
}