You need to enable JavaScript to run this app.
导航
返回结构
最近更新时间:2023.08.02 11:53:38首次发布时间:2023.08.02 11:53:38

正常返回示例

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

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

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

公共参数说明:

参数名称类型说明
RequestIDStringRequestID 为每次 API 请求的唯一标识。
ActionString请求的接口名,属于请求的公共参数。
VersionString请求的接口版本号,属于请求的公共参数。
ServiceString请求的服务名,属于请求的公共参数。
RegionString服务所在的地域信息,属于请求的公共参数。

说明

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字段,包括CodeMessage

公共参数说明:

参数名称类型说明

CodeN

int

CodeN 为标识错误码的数字 ID,方便查找问题。

说明

仅部分接口会提供 CodeN。

CodestringCode 内容为具体的错误码,您可根据错误码查询文档自助解决问题。
MessagestringMessage 描述了错误发生的具体原因,供您排查问题参考。