返回结果
调用 API 服务后返回数据采用统一格式:
- 返回的 HTTP 状态码为 2xx,代表调用成功。
- 返回的 HTTP 状态码为 4xx 或 5xx,代表调用失败。
调用成功返回的数据格式为 JSON ,外部系统可以在请求时指定返回的数据格式为 JSON 格式。
本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
成功结果
JSON
示例
{
"RequestId": "AB467B42-2210-4489-99BC-23049166F265",
/* 返回结果数据 */
}
错误结果
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述 公共错误码 来定位错误原因。
当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。
返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求 ID:RequestId 和一个您该次请求访问的站点 ID:HostId。在调用方找不到错误原因时,可以联系阿里云客服,并提供该 HostId 和 RequestId,以便我们尽快帮您解决问题。
具体格式及错误码请参考 错误处理 。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论