# 查询链路追踪span数据（V2） - SearchSkywalkingTraceSpan #### 功能介绍 查询链路追踪span数据。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-apm/apm_04_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apm/apm_04_0021.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | apm:application:getTraceEvents | Write | - | g:EnterpriseProjectId | - apm:apm2TraceEvent:get - apm:apm2TraceEvents:get - apm:apm2BusinessSpanSearch:get | - | #### URI POST /v2/view/sw/trace/span-search #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | x-business-id | 是 | Long | 应用id。 | | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | region | 是 | String | region名称。 | | page_size | 否 | Integer | 每一页返回的行数。 | | page | 否 | Integer | 查询第几页的数据,默认查询第一页。 | | order_param | 否 | [OrderParam] object | 排序。 | | time_used_min | 否 | Long | 最小耗时。 | | time_used_max | 否 | Long | 最大耗时。 | | trace_id | 否 | String | 在root的span调用产生的全局id，以此往后透传。 | | start_time | 否 | Long | 开始时间。 | | end_time | 否 | Long | 结束时间。 | | has_error | 否 | Boolean | 是否有错误。 | | http_method | 否 | String | 这里的method实际上是tags里面的http_method，只有url监控项才有。 | | domain_id | 否 | Integer | 租户id。 | | biz_id | 是 | Long | 应用id。 | | app_id | 否 | Long | 组件id。 | | env_id | 否 | Long | 环境id。 | | instance_id | 否 | Long | 实例id。 | | time_used | 否 | Long | 耗时。 | | start_time_string | 否 | String | 开始时间。 | | end_time_string | 否 | String | 结束时间。 | | url | 否 | String | url过滤。 | | parameters | 否 | String | 自定义参数过滤。 | 表3OrderParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | field | 否 | String | 指定排序字段。默认值为startTime 。 枚举值： timeUsed ：响应时间 startTime ：开始时间 | | order | 否 | String | 排序方式，默认为DESC。 枚举值： ASC DESC | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总数。 | | span_list | Array of [TracingSpanResponse_TraceSpan] objects | span信息列表。 | 表5TracingSpanResponse_TraceSpan | 参数 | 参数类型 | 描述 | |:---|:---|:---| | trace_id | String | 调用链Id。 | | start_time | Long | 开始时间。 | | end_time | Long | 结束时间。 | | operation_name | String | 操作名称，表示被追踪的调用方法。 | | has_error | Boolean | 是否报错。 | | tags | Map\ | 包含用户自定义参数，header或body体里的内容，httpMethod，bizCode，以及后续可能新增参数。 | | biz_id | Long | 应用id。 | | app_id | Long | 组件id。 | | env_id | Long | 环境id。 | | instance_id | Long | 实例id。 | | time_used | Long | 请求耗时。 | | http_method | String | 这里的method实际上是tags里面的http_method，只有url监控项才有。 | | env_name | String | 环境名称。 | | instance_name | String | 实例名称。 | | app_name | String | 组件名称。 | | region | String | 区域。 | | host_name | String | 主机名称。 | | ip_address | String | ip地址。 | | component_name | String | 组件名称。 | | domain_id | String | 内部租户id。 | #### 请求示例 ``` /v2/view/sw/trace/span-search { "region" : "cn-north-7", "biz_id" : 1189924, "page" : 1, "page_size" : 15, "order_param" : { "field" : "startTime", "order" : "ASC" }, "start_time_string" : 1767578514475, "end_time_string" : 1767664914475 } ``` #### 响应示例 **状态码：200** OK ``` { "total" : 2, "span_list" : [ { "trace_id" : "0e3a4e6d5f374a29b91e7417ea079579.61.17676201285770001", "start_time" : 1767620128578, "operation_name" : "/rolldice", "has_error" : false, "domain_id" : 2, "biz_id" : 1189924, "app_id" : 610278, "env_id" : 375760, "instance_id" : 171636, "time_used" : 219, "http_method" : "GET", "env_name" : "dev", "instance_name" : "GPt6B@100.91.60.51@8dacbe4bf409cad48", "app_name" : "java", "region" : "cn-north-7", "host_name" : "GPt6B", "ip_address" : "100.91.60.51", "component_name" : "", "print_trace_id_flag" : false, "span_id" : "a7ffa728e1fce150" }, { "trace_id" : "0e3a4e6d5f374a29b91e7417ea079579.62.17676201300720001", "start_time" : 1767620130072, "operation_name" : "/rolldice", "has_error" : false, "domain_id" : 2, "biz_id" : 1189924, "app_id" : 610278, "env_id" : 375760, "instance_id" : 171636, "time_used" : 225, "http_method" : "GET", "env_name" : "dev", "instance_name" : "GPt6B@100.91.60.51@8dacbda3ec6ac5409cad48", "app_name" : "java", "region" : "cn-north-7", "host_name" : "GPt6B", "ip_address" : "100.91.60.51", "component_name" : "", "print_trace_id_flag" : false, "span_id" : "37ddbb29e2fce150" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 400 | Bad Request。 | | 403 | Forbidden。 | | 429 | Too Many Requests。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-apm/ErrorCode.html)。