返回结构

正常返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****", 
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}" 
    },
    "Result":"..."
}

请求被正常处理后，返回中会包含ResponseMetadata和Result两部分，Result视请求的接口而定，不同的接口会有不同的Result返回。

公共参数说明：

异常返回示例

接口调用出错后，会返回 RequestId 和错误信息，我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。

您可以根据接口错误代码 Code 和错误信息 Message ，参考公共错误码和接口错误码排查错误。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
        "Error": {
		        "CodeN": 100008,
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation GetUserById for version 2018-01-01"
        }
    }
}

相较于成功结果，错误结果将不再有Result部分，而ResponseMetadata中将额外出现Error字段，包括Code和Message。

公共参数说明：