Common response parameters

更新时间:
复制 MD 格式

The Alibaba Cloud Visual Intelligence API is a Remote Procedure Call (RPC) API. All API responses contain a set of common response parameters.

The system returns a unique RequestId for every API call, regardless of whether the call succeeds or fails.

Request example

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

Successful result example

An HTTP status code of 2xx indicates that an API call is successful. For a successful call, the system returns data in a standard format, which can be either XML or JSON. You can specify the response data format by passing a parameter in the request. The default format is XML. The response examples in this document are formatted for readability. The actual response does not include line breaks or indents.

  • JSON format
    {
        "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
        /* Response data */
    } 
  • XML format
    <?xml version="1.0" encoding="utf-8"?> 
    <!--Root node of the result-->
    <APIName+Response>
        <!--Request tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Response data-->
    </APIName+Response>

Error result example

When an API call fails, it returns an HTTP status code of 4xx or 5xx. The response body contains a specific error code, an error message, a globally unique request ID (RequestId), and the site ID (HostId) for the request. You can use the returned error code to identify the cause of the error. If you cannot identify the cause, contact an Alibaba Cloud customer service representative and provide the HostId and RequestId to help resolve the issue quickly.

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