返回结果
最近更新时间:2024-06-04 03:04:13
调用 API 服务后返回数据采用统一格式:
返回的 HTTP 状态码为 2xx,代表调用成功。 返回的 HTTP 状态码为 4xx 或 5xx,代表调用失败。
用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户。
1. 成功返回结果
{
"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68FXXXX"
}
RequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。
2. 错误返回结果
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述公共错误码来定位错误原因。 当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求 ID:RequestId。
{
"ErrorCode":"InternalError",
"ErrorMessage":"The request processing has failed due to some unknown error.",
"RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228XXXX"
}
ErrorCode 表示具体出错的错误码,当请求出错时可以先根据该错误码在公共错误码和当前接口对应的错误码列表里面查找对应原因和解决方案。
ErrorMessage 显示出了这个错误发生的具体原因,随着业务发展或体验优化,此文本可能会经常保持变更或更新,用户不应依赖这个返回值。
RequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。
3. 公共错误码
ErrorCode | ErrorMessage |
---|---|
SignatureDoesNotMatch | Specified signature is not matched with our calculation. |
本页目录: