You need to enable JavaScript to run this app.
导航

返回示例

最近更新时间2023.09.04 18:49:42

首次发布时间2021.07.31 07:47:46

所有的返回数据都会带上RequestIdActionVersionServiceRegion这几个字段。

正常返回示例

接口调用成功后会返回请求ID和接口返回参数,我们称这样的返回为正常返回。正常返回HTTP状态码为2xx

{
    "ResponseMetadata": {
        "RequestId": "202004011722300102****", //从X-Top-Request-Id的Header获取。
        "Action": "{Action}",//从请求Action的query获取。
        "Version": "{Version}",//从请求Version的query获取。
        "Service": "{Service}",//从X-Top-Service的header获取。
        "Region": "{Region}" //从X-Top-Region的header获取。
    },
    "Result":"..."
}

请求被正常处理后,返回中会包含ResponseMetadataResult两部分,字段解释如下:

字段解释
RequestIDRequestID为每次API请求的唯一标识。
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字段,字段解释如下:

字段解释
ErrorError出现表明本次请求失败。
CodeCode内容为具体的错误码,您可根据错误码查询文档自助解决问题。
MessageMessage描述了错误发生的具体原因,供您排查问题参考。
RequestIDRequestID是每次API请求的唯一标识,当出现了无法自助解决的问题时,您可通过工单系统联系我们,提供请求的RequestID,我们将协助进行故障排查。