返回結果主要有JSON 格式,您可以指定公共請求參數 Format 變更返回結果的格式。更多詳情,請參閱 公共參數。為了便于查看和美觀,API 文檔返回示例均有換行和縮進等處理,實際返回結果無換行和縮進處理。
正常返回示例:
接口調用成功后會返回接口返回參數和請求 ID,我們稱這樣的返回為正常返回。HTTP 狀態碼為 2xx。
JSON示例
{
"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
"Code" : "200"
}
異常返回示例:
接口調用出錯后,會返回錯誤碼、錯誤信息和請求 ID,我們稱這樣的返回為異常返回。HTTP 狀態碼為 4xx 或者 5xx。
您可以根據接口錯誤碼,參考 公共錯誤碼 以及 API 錯誤中心 排查錯誤。當您無法排查錯誤時,可以 提交工單 聯系我們,并在工單中注明 RequestId。
JSON示例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
"Code" : "-2"
"Message":"xxxxxxx"
}
備注
更多返回錯誤代碼請看公共API欄目下的公共錯誤代碼文檔描述