返回结果

调用火山引擎 OpenAPI 后，所有返回结果都会带上 RequestId、Action、Version、Service、Region 等字段。

正常返回示例

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

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

请求被正常处理后，返回中会包含 ResponseMetadata 和 Result 两部分，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 2018-01-01"
        }
    }
}