GetTraceConfig - 获取trace配置-API 网关(API Gateway)-阿里云帮助中心

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:GetTraceConfig

get

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
gatewayId	string	否	网关实例 ID	gw-xxx

请求参数

名称	类型	必填	描述	示例值
acceptLanguage	string	否	语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	返回参数
requestId	string	请求 ID	2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
code	integer	请求响应码	200
success	boolean	boolean 请求结果，取值如下： true：请求成功。 false：请求失败。	true
message	string	错误信息	success
data	object	响应数据
enable	boolean	是否开启链路追踪: true：开启 false：关闭	true
sampleRatio	integer	采样率	50
traceType	string	链路追踪类型： XTRACE SKYWALKING OPENTELEMETRY OTSKYWALKING	SKYWALKING
serviceId	string	服务 ID，链路追踪类型为 SKYWALKING 时存在该参数	ss-co370icmjeu****
servicePort	string	服务端口，链路追踪类型为 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"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。