调用 API 服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回 4xx 或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式为XML。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
XML返回结果包括请求是否成功信息和具体的业务数据。示例如下:
![]()
错误结果
调用接口出错后,将不会返回结果数据,具体的错误信息请参考 [backcolor=transparent]错误响应。
当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId 和一个您该次请求访问的站点ID:HostId。在调用方找不到错误原因,可以联系阿里云客服,并提供该 HostId 和 RequestId,以便我们尽快帮您解决问题。
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
您提到的是调用API时返回数据的格式以及HTTP状态码的含义,这在使用阿里云服务或任何其他基于API的服务时非常重要。下面是对您描述内容的一个总结和补充:
Accept
头部或者API本身的规定。用户可以在发送请求时通过这个头部来指定希望接收的响应格式,例如设置为application/json
或application/xml
。<?xml version="1.0" encoding="UTF-8"?>
<Response>
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<HostId>example.host.id</HostId>
<Success>true</Success>
<!-- 具体业务数据 -->
</Response>
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<HostId>example.host.id</HostId>
<Code>InvalidParameter</Code>
<Message>The specified parameter is invalid.</Message>
</Error>
RequestId
和HostId
联系阿里云客服获取帮助。确保在调用阿里云API时,仔细阅读相关文档,了解每个API的具体要求和响应格式,这样可以更有效地处理各种响应情况。