所有的返回都会带上RequestId、Action、Version、Service、Region等字段。
接口调用成功后会返回请求 ID和接口返回参数,我们称这样的返回为正常返回。HTTP 状态码为 2xx。
{ "ResponseMetadata": { "RequestId": "202010201722300102****", "Action": "{Action}", "Version": "{Version}", "Service": "{Service}", "Region": "{Region}" }, "Result":"..." }
请求被正常处理后,返回中会包含ResponseMetadata
和Result
两部分,字段解释如下:
字段 | 解释 |
---|---|
RequestID | RequestID为每次OpenAPI请求的唯一标识。 |
Action | 请求的接口名,属于请求的公共参数。 |
Version | 请求的版本号,属于请求的公共参数。 |
Service | 请求的服务,属于请求的公共参数。 |
Result视请求的接口而定,不同的接口会有不同的Result返回。
接口调用出错后,会返回请求ID和错误信息,我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。
您可以根据接口错误代码Code和错误信息Message,参考公共错误码和接口错误码排查错误。
{ "ResponseMetadata": { "RequestId": "202010201722300102****", "Action": "{Action}", "Version": "{Version}", "Service": "{Service}", "Region": "{Region}", "Error": { "Code": "InvalidActionOrVersion", "Message": "Could not find operation GetUserById for version 2020-04-01 } } }
相较于成功结果,错误结果将不再有Result
部分,而ResponseMetadata
中将额外出现Error字段,字段解释如下:
字段 | 解释 |
---|---|
Error | Error出现表明本次请求失败。 |
Code | Code内容为具体的错误码,您可根据错误码查询文档自助解决问题。 |
Message | Message描述了错误发生的具体原因,供您排查问题参考。 |
RequestID | RequestID是每次API请求的唯一标识,当出现了无法自助解决的问题时,您可通过工单系统联系我们,提供请求的RequestID,我们将协助进行故障排查。 |