GetTraceConfig - 获取trace配置

更新时间:
复制为 MD 格式

获取链路追踪配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /v1/gateways/{gatewayId}/trace HTTP/1.1

请求参数

名称类型必填描述示例值
gatewayIdstring

网关实例 ID

gw-xxx
acceptLanguagestring

语言类型: zh:中文 en:英文

zh

返回参数

名称类型描述示例值
object

返回参数

requestIdstring

请求 ID

2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
codeinteger

请求响应码

200
successboolean

boolean 请求结果,取值如下: true:请求成功。 false:请求失败。

true
messagestring

错误信息

success
dataobject

响应数据

enableboolean

是否开启链路追踪: true:开启 false:关闭

true
sampleRatiointeger

采样率

50
traceTypestring

链路追踪类型:

  • XTRACE
  • SKYWALKING
  • OPENTELEMETRY
  • OTSKYWALKING
SKYWALKING
serviceIdstring

服务 ID,链路追踪类型为 SKYWALKING 时存在该参数

ss-co370icmjeu****
servicePortstring

服务端口,链路追踪类型为 SKYWALKING 时存在该参数

8090

示例

正常返回示例

JSON格式

{
  "requestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "code": 200,
  "success": true,
  "message": "success",
  "data": {
    "enable": true,
    "sampleRatio": 50,
    "traceType": "SKYWALKING",
    "serviceId": "ss-co370icmjeu****",
    "servicePort": 8090
  }
}

错误码

访问错误中心查看更多错误码。