阿里云视觉智能开放平台是RPC API类型接口,所有的API响应均提供一组公共响应头。

您每次发送的接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId。

请求示例

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

成功结果示例

调用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": "imgsearch.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>imgsearch.cn-shanghai.aliyuncs.com</HostId>
       <Code>UnsupportedOperation</Code>
       <Message>The specified action is not supported.</Message>
    </Error>