調用API服務后返回數據采用統一格式,返回的 HTTP 狀態碼為2xx
,代表調用成功;返回4xx
或5xx
的HTTP狀態碼代表調用失敗。
調用成功返回的數據格式主要有XML和JSON兩種,外部系統可以在請求時傳入參數來指定返回的數據格式,默認為XML格式。本文檔中的返回示例為了便于用戶查看,做了格式化處理,實際返回結果是沒有進行換行、縮進等處理的。
成功結果
XML示例
XML返回結果包括請求是否成功信息和具體的業務數據。示例如下:
<?xml version="1.0" encoding="utf-8"?>
<!—結果的根結點-->
<接口名稱+Response>
<!—返回請求標簽-->
<RequestId>xxxxxxxxx</RequestId>
<!—返回結果數據-->
</接口名稱+Response>
JSON 示例
{ "RequestId": "xxxxxxxxx" /*返回結果數據*/ }
錯誤結果
調用接口出錯后,將不會返回結果數據。調用方可根據附錄的錯誤碼 來定位錯誤原因。
當調用出錯時,HTTP 請求返回一個4xx
或5xx
的HTTP狀態碼。返回的消息體中是具體的錯誤代碼及錯誤信息。另外還包含一個全局唯一的請求ID:RequestId和一個您該次請求訪問的站點ID:HostId。在調用方找不到錯誤原因,可以聯系阿里云客服,并提供該HostId和RequestId,以便我們盡快幫您解決問題。
XML示例
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<RequestId>xxxxxxxxxxxxxxxxxxx</RequestId>
<HostId>petadata.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message>"This specified action is not valid</Message>
</Error>
JSON示例
{ "RequestId": "xxxxxxxxxxxxxxxxxxx", "HostID": "petadata.aliyuncs.com ", "Code": "UnsupportedOperation", "Message": "This specified action is not valid" }