调用API服务后返回数据采用统一格式,返回的 HTTP 状态码为2xx,代表调用成功;返回4xx5xx 的HTTP状态码代表调用失败。

调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来指定返回的数据格式,默认为XML格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

XML示例

XML返回结果包括请求是否成功信息和具体的业务数据。示例如下:

<?xml version="1.0" encoding="utf-8"?>  
<!—结果的根结点--> 
<接口名称+Response> 
    <!—返回请求标签--> 
 <RequestId>xxxxxxxxx</RequestId> 
    <!—返回结果数据--> 
</接口名称+Response>

JSON 示例

{ 
    "RequestId": "xxxxxxxxx"
    /*返回结果数据*/
}

错误结果

调用接口出错后,将不会返回结果数据。调用方可根据附录的错误码 来定位错误原因。

当调用出错时,HTTP 请求返回一个4xx5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId。在调用方找不到错误原因,可以联系阿里云客服,并提供该HostId和RequestId,以便我们尽快帮您解决问题。

XML示例

<?xml version="1.0" encoding="UTF-8"?> 
<Error> 
   <RequestId>xxxxxxxxxxxxxxxxxxx</RequestId> 
   <HostId>petadata.aliyuncs.com</HostId> 
   <Code>UnsupportedOperation</Code> 
   <Message>"This specified action is not valid</Message> 
</Error> 

JSON示例

{ 
"RequestId": "xxxxxxxxxxxxxxxxxxx", 
"HostID": "petadata.aliyuncs.com ", 
"Code": "UnsupportedOperation", 
    "Message": "This specified action is not valid"
}