本文为您介绍OpenAPI服务的返回结果。
返回结果格式
调用OpenAPI服务后返回数据采用统一格式:
- 返回的HTTP状态码为
2xx
,代表调用成功。 - 返回的HTTP状态码为
4xx
或5xx
,代表调用失败。
说明 本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
返回结果成功
调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。返回结果成功示例如下:
{}
返回结果错误
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述 公共错误码来定位错误原因。 当调用出错时,HTTP
请求返回一个 4xx
或 5xx
的 HTTP
状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId
和一个您该次请求访问的站点ID:HostId
。在调用方找不到错误原因时,可以联系阿里云客服,并提供该 HostId
和 RequestId
,以便尽快为您解决问题。返回结果错误示例如下:
null
公共错误码
请参见:公共错误码表。
在文档使用中是否遇到以下问题
更多建议
匿名提交