全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
负载均衡

返回结果

更新时间:2017-12-05 19:23:20

调用API服务后返回数据采用统一格式:

  • 返回的HTTP状态码为2xx,代表调用成功。
  • 返回的HTTP状态码为4xx或5xx,代表调用失败。

调用成功返回的数据格式主要有XML和JSON 两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。

说明: 本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行和缩进等处理的。

成功结果

XML示例:

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

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!—结果的根结点-->
  3. <接口名称+Response>
  4. <!—返回请求标签-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!—返回结果数据-->
  7. </接口名称+Response>

JSON示例:

  1. {
  2. "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
  3. /*返回结果数据*/
  4. }

错误结果

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

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

XML示例:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Error>
  3. <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
  4. <HostId>slb.aliyuncs.com</HostId>
  5. <Code>UnsupportedOperation</Code>
  6. <Message>The specified action is not supported.</Message>
  7. </Error>

JSON示例:

  1. {
  2. "RequestId":"7463B73D-35CC-4D19-A010-6B8D65D242EF",
  3. "HostId":"slb.aliyuncs.com",
  4. "Code":"UnsupportedOperation",
  5. "Message":"The specified action is not supported."
  6. }
本文导读目录