調用API服務後返回資料採用統一格式,返回的HTTP狀態代碼為2xx,代表調用成功;返回4xx或5xx的HTTP狀態代碼代表調用失敗。調用成功返回的資料格式主要有XML和JSON兩種,外部系統可以在請求時傳入參數來制定返回的資料格式,預設為XML格式。本文檔中的返回樣本為了便於使用者查看,做了格式化處理,實際返回結果是沒有進行換行、縮排等處理的。

成功結果

  • 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>sts.aliyuncs.com</HostId>
       <Code>InvalidParameter</Code>
       <Message>The specified parameter "Action or Version" is not valid.</Message>
    </Error>
  • JSON樣本
    {
        "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
        "HostId": "sts.aliyuncs.com",
        "Code": "InvalidParameter",
        "Message": "The specified parameter \"Action or Version\" is not valid."
    }