阿里云視覺智能開放平臺是RPC API類型接口,所有的API響應均提供一組公共響應頭。

您每次發送的接口調用請求,無論成功與否,系統都會返回一個唯一識別碼RequestId。

請求示例

https://imageaudit.cn-shanghai.aliyuncs.com/
?Format=xml
&Version=2019-12-30
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2014-10-10T12:00:00Z

成功結果示例

調用API服務后,系統采用統一格式返回數據。返回2xx的HTTP狀態碼表示調用成功,調用成功返回的數據格式主要有XML和JSON兩種。外部系統可以在請求時傳入參數來制定返回的數據格式,默認為XML格式。為了便于查看,本文檔中的返回示例做了格式化處理,實際返回結果沒有進行換行、縮進等處理。

  • JSON格式
    {
        "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
        /* 返回結果數據 */
    } 
  • XML格式
    <?xml version="1.0" encoding="utf-8"?> 
    <!—結果的根結點-->
    <接口名稱+Response>
        <!—返回請求標簽-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!—返回結果數據-->
    </接口名稱+Response>

錯誤結果示例

當調用出錯時,HTTP請求會返回一個4xx或5xx的HTTP狀態碼。返回的消息體中包含具體的錯誤碼及錯誤信息,還包含一個全局唯一的請求ID(RequestId)和一個該次請求訪問的站點ID(HostId)。您可以根據返回的錯誤碼來定位錯誤原因。若無法在調用方定位錯誤原因,請聯系阿里云客服人員,并提供該HostId和RequestId,以便能盡快幫您解決問題。

  • JSON格式
    {
        "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
        "HostId": "imageaudit.cn-shanghai.aliyuncs.com",
        "Code": "UnsupportedOperation",
        "Message": "The specified action is not supported."
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8"?>
    <Error>
       <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
       <HostId>imageaudit.cn-shanghai.aliyuncs.com</HostId>
       <Code>UnsupportedOperation</Code>
       <Message>The specified action is not supported.</Message>
    </Error>