You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /云服务器/云服务器ECS/API参考/调用方式/响应结果
响应结果
最近更新时间：2022.11.04 17:41:45首次发布时间：2021.07.31 07:48:16
我的收藏

响应结果

所有的返回都会带上RequestId、Action、Version、Service、Region等字段。

正常返回示例

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

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

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

字段解释
RequestIdRequestId为每次API请求的唯一标识。
Action请求的接口名，属于请求的公共参数。
Version请求的版本号，属于请求的公共参数。
Service请求的服务，属于请求的公共参数。
Region服务所在的地域信息，属于请求的公共参数。

异常返回示例

接口调用出错后，会返回RequestId和错误信息，我们称这样的返回为异常返回。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 2018-01-01"
        }
    }
}

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

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