本文檔中的返回示例為了便于用戶查看,做了格式化處理,實際返回結果是沒有進行換行、縮進等處理的。

調用 API 服務后返回數據采用統一格式:返回的 HTTP 狀態碼為 2xx,代表調用成功。 返回的 HTTP 狀態碼為 4xx 或 5xx,代表調用失敗。 調用成功返回的數據格式主要有 XML 和 JSON 兩種,外部系統可以在請求時傳入參數來制定返回的數據格式,默認為 XML 格式。

成功結果

JSON示例:
{
    "Data":"true",
    "RequestId":"2670BCFB-925D-4C3E-9994-8D12F7A9F538"
}

錯誤結果

調用接口出錯后,將不會返回結果數據。調用方可根據每個接口對應的錯誤碼以及下述公共錯誤碼來定位錯誤原因。 當調用出錯時,HTTP 請求返回一個 4xx 或 5xx 的 HTTP 狀態碼。返回的消息體中是具體的錯誤代碼及錯誤信息。另外還包含一個全局唯一的請求 ID:RequestId 和一個您該次請求訪問的站點 ID:HostId。在調用方找不到錯誤原因時,可以聯系阿里云客服,并提供該 HostId 和 RequestId,以便我們盡快幫您解決問題。

JSON示例:
{
    "code":"FLOW_API_FAILED",
    "message":"project not exist",
    "requestId":"11BAFBD8-8509-4177-A26D-407505E73713",
    "successResponse":false
}

公共錯誤碼

請參照:公共錯誤碼表