获取链路追踪调用链详情(V2) - ShowSkywalkingTraceTraceDetail
功能介绍
获取链路追踪调用链详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:getTraceEvents
Write
-
g:EnterpriseProjectId
- apm:apm2TraceEvent:get
- apm:apm2TraceEvents:get
- apm:apm2BusinessSpanSearch:get
-
URI
GET /v2/view/sw/trace/get-trace-detail
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| trace_id | 是 | String | 调用链ID。 |
| business_id | 否 | Long | 应用id。is_otel为false时,需要指定应用id。 |
| is_otel | 否 | Boolean | 是否为opentelemetry探针上报的调用链,默认为false。 |
| start_time | 否 | Long | 开始时间,毫秒级时间戳。 |
| end_time | 否 | Long | 结束时间,毫秒级时间戳。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| component_num | Integer | 组件数。 |
| layer | Integer | 深度。 |
| span_list | Array of TraceSpanInfo objects | span信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| trace_id | String | traceId。 |
| span_id | String | span id。 |
| parent_spanId | String | 父span id。 |
| start_time | Integer | 开始时间。 |
| operation_name | String | 操作名称,表示被追踪的调用方法。 |
| span_type | String | span类型。 |
| has_error | Integer | 是否有错误。 |
| tags | Map<String,String> | 包含用户自定义参数,header或body体里的内容,httpMethod,bizCode,以及后续可能新增参数。 |
| inner_domain_id | Integer | 内部租户id。 |
| biz_id | Integer | 应用id。 |
| env_id | Integer | 环境id。 |
| instance_id | Integer | 实例id。 |
| time_used | Integer | 耗时。 |
| env_name | String | 环境名称、 |
| instance_name | String | 实例名称。 |
| app_name | String | 组件名称。 |
| region | String | 局点。 |
| host_name | String | 主机名。 |
| ip_address | String | 主机地址。 |
| project_id | String | 租户在region对应项目id,用于标识日志组与日志流所在的region。 |
| log_group_id | String | 日志组id。 |
| print_trace_id_flag | Boolean | 是否打印traceId。 |
| log_stream_id | String | 日志流id。 |
| project_name | String | 租户在region对应项目id,用于标识日志组与日志流所在的region。 |
| app_type | String | 组件类型。 |
| children | Array of TraceSpanInfo objects | 子span。 |
请求示例
查询Skywalking应用下指定traceId的调用链信息。
v2/view/sw/trace/get-trace-detail?trace_id=0e3a4e6d5f374a29b91e7417ea079579.61.17676201285770001&business_id=1189924
响应示例
状态码:200
OK
{
"component_num" : 1,
"layer" : 1,
"span_list" : [ {
"trace_id" : "0e3a4e6d5f374a29b91e7417ea079579.61.17676201285770001",
"span_id" : "a7ffa728e1fce150",
"parent_spanId" : "",
"start_time" : 1767620128578,
"operation_name" : "GET /rolldice",
"span_type" : "SPAN_KIND_SERVER",
"tags" : {
"http.status_code" : "200",
"componentId" : "1",
"http.target" : "/rolldice",
"http.url" : "http://localhost:8060/rolldice",
"http.method" : "GET"
},
"inner_domain_id" : 2,
"biz_id" : 1189924,
"env_id" : 375760,
"instance_id" : 171636,
"time_used" : 219,
"env_name" : "dev",
"instance_name" : "GPt6B@10.91.60.51@8dacbda379ae4bf",
"app_name" : "java",
"region" : "cn-north-4",
"host_name" : "GPt6B",
"ip_address" : "10.91.60.51",
"print_trace_id_flag" : false,
"app_type" : "JAVA"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 400 | Bad Request。 |
| 403 | Forbidden。 |
| 429 | Too Many Requests。 |
错误码
请参见错误码。