文档中心

API 网关

网关管理

UpdateGatewayTrace - 更新网关链路追踪配置

更新网关链路追踪配置。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=UpdateGatewayTrace&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：UpdateGatewayTrace

要执行的操作，取值：UpdateGatewayTrace。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

Id string 必选示例值：gd8****

网关实例 ID。

TraceSpec object 必选示例值：-

链路追踪配置。

Enable boolean 必选示例值：true

是否开启链路追踪。取值：

true：开启。

false：不开启。

TraceType string 必选示例值：tls

链路追踪类型，取值：

tls：日志服务。

apm：应用性能监控全链路版。

说明

当TraceSpec.Enable值为 true 时，需要配置本参数。

TLSTraceSpec object 可选示例值：-

日志服务链路追踪配置。

说明

当TraceSpec.TraceType值为 tls 时，需要配置本参数。

TraceId string 可选示例值：0fda****

Trace ID，取值为空时会生成一个 Trace ID 并创建 Trace 实例。详情请参见创建 Trace 实例。

ProjectId string 必选示例值：fc69****

日志项目 ID。详情请参见创建日志项目。

IAMUserAK string 可选示例值：AKLTZ****

密钥 ID（Access Key ID）。详情请参见创建访问密钥。

IAMUserSK string 可选示例值：WTJU****

私有密钥（Secret Access Key）。详情请参见创建访问密钥。

APMTraceSpec object 可选示例值：-

应用性能监控全链路版链路追踪配置。

说明

当TraceSpec.TraceType值为 apm 时，需要配置本参数。

APIKey string 必选示例值：ark-96****

API Key。详情请参见创建 API Key。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Id string 示例值：gd8****

网关实例 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
404	ResourceNotFound	The specified resource %s %s cannot be found.	指定资源找不到。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.10.28 14:59:49

这个页面对您有帮助吗？

有用

无用