文档中心

公网IP

调用方式

返回示例

所有的返回数据都会带上RequestId，Action，Version，Service，Region这几个字段。

正常返回示例

接口调用成功后会返回请求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":"..."​
}​

请求被正常处理后，返回中会包含ResponseMetadata和Result两部分，字段解释如下：

字段	解释
RequestID	RequestID为每次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字段，字段解释如下：

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

最近更新时间：2025.07.23 16:18:00

这个页面对您有帮助吗？

有用

无用