所有的返回都会带上 RequestId、Action、Version、Service、Region 等字段。本文介绍不同的返回示例。

正常返回示例 #

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

{
    "ResponseMetadata": {
        "RequestId": "2020102017223001022507", 
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}" 
    },
    "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
        }
    }
}