You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
网关管理
UpdateGatewayTrace - 更新网关链路追踪配置
复制全文
下载 pdf
UpdateGatewayTrace - 更新网关链路追踪配置
更新网关链路追踪配置。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=UpdateGatewayTrace&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
UpdateGatewayTrace​
接口名称。当前 API 的名称为 UpdateGatewayTrace。​
Version​
String​
是​
2021-03-03​
接口版本。当前 API 的版本为 2021-03-03。​
Id​
String​
是​
gd8****​
网关实例 ID。​
TraceSpec​
Object of TraceSpec​
是​
-​
链路追踪配置。​
​
TraceSpec​
​
参数​
类型​
是否必选​
示例值​
描述​
Enable​
Boolean​
是​
true​
是否开启链路追踪。取值:​
  • true:开启。​
  • false:不开启。​
TraceType​
String​
是​
tls​
链路追踪类型,取值:​
  • tls:日志服务。​
  • apm:应用性能监控全链路版。​
说明​
当TraceSpec.Enable值为 true 时,需要配置本参数。​
TLSTraceSpec​
Object of TLSTraceSpec​
否​
-​
日志服务链路追踪配置。​
说明​
当TraceSpec.TraceType值为 tls 时,需要配置本参数。​
APMTraceSpec​
Object of APMTraceSpec​
否​
-​
应用性能监控全链路版链路追踪配置。​
说明​
当TraceSpec.TraceType值为 apm 时,需要配置本参数。​
​
TLSTraceSpec​
​
参数​
类型​
是否必选​
示例值​
描述​
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​
​
参数​
类型​
是否必选​
示例值​
描述​
APIKey​
String​
是​
ark-96****​
API Key。详情请参见 创建 API Key。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=UpdateGatewayTrace&Version=2021-03-03​
Content-Type: application/json​
{​
"Id": "gd8****",​
"TraceSpec": {​
"Enable": true,​
"TraceType": "tls",​
"APMTraceSpec": {​
"APIKey": "ark-96****"​
},​
"TLSTraceSpec": {​
"TraceId": "0fda****",​
"IAMUserAK": "AKLTZ****",​
"IAMUserSK": "WTJU****",​
"ProjectId": "fc69****"​
}​
}​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Id​
String​
gd8****​
网关实例 ID。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "UpdateGatewayTrace",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "gd8****"​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:02
这个页面对您有帮助吗?
有用
有用
无用
无用