调用 API 服务后返回数据采用统一格式:
返回的 HTTP 状态码为 2xx,代表调用成功。 返回的 HTTP 状态码为 4xx 或 5xx,代表调用失败。 调用成功返回的数据格式主要有 XML 和 JSON 两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为 XML 格式。
本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。 成功结果
JSON示例
{ "RequestId":"629586FE-CB2E-4742-995E-121F952CEB72" }
错误结果
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述 公共错误码 来定位错误原因。 当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求 ID:RequestId 和一个您该次请求访问的站点 ID:HostId。在调用方找不到错误原因时,可以联系阿里云客服,并提供该 HostId 和 RequestId,以便我们尽快帮您解决问题。
JSON示例
{ "Code":"InvalidTenant", "HostId":"iovcc.cn-shanghai.aliyuncs.com", "Message":"User is not a valid tenant", "RequestId":"6F25F67C-F411-499F-BCE2-67CA563CB064" }
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。