返回结果

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

正常返回示例

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

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

异常返回示例

接口调用出错后，会返回请求 ID 和错误信息。HTTP 状态码为 4xx 或者 5xx。
您可以根据接口错误代码 Code 和错误信息 Message，参考错误码排查错误。
如果返回结果中存在 Error 字段，则表示调用 API 接口失败。例如：

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
        "Error": {
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation GetUserById for version 2022-05-12"
        }
    }
}