文档中心

应用性能监控全链路版

请输入

调用方式

返回结果

调用火山引擎 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 返回。字段解释如下：

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

异常返回示例

接口调用出错后，会返回请求 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"​
        }​
    }​
}​

最近更新时间：2025.09.01 20:18:21

这个页面对您有帮助吗？

有用

无用