调用API服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

XML示例
<?xml version="1.0" encoding="UTF-8" ?>
    <!-结果的根结点-->
    <接口名称+ Response>
        <!-返回请求标签-->
        <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
        <!-返回结果数据-->
    </接口名称+Response>
JSON示例
{
        "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回结果数据 */
    }

失败结果

调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及 错误码表 来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId。在调用方找不到错误原因时,可以联系阿里云客服,并提供该HostId和RequestId,以便我们尽快帮您解决问题。

XML示例
<?xml version="1.0" encoding="UTF-8"?> 
    <Error>
        <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId> 
        <HostId>mts.cn-hangzhou.aliyuncs.com</HostId> 
        <Code>UnsupportedOperation</Code>
        <Message>The specified action is not supported.</Message>
    </Error>
JSON示例

{
"RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5", 
"HostId": "mts.cn-hangzhou.aliyuncs.com", 
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}