全部产品
Search
文档中心

可观测链路 OpenTelemetry 版:SearchTraces - 查询调用链列表

更新时间:Nov 14, 2024

调用SearchTraces查询调用链列表,可根据时间、应用名称、IP地址、Span名称、Tag等信息对调用链进行过滤查询。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
xtrace:SearchTraceget
  • 全部资源
    *

请求参数

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

开始时间,精确到毫秒(ms)。

1714298814000
EndTimelong

结束时间,精确到毫秒(ms)。

1714385214000
RegionIdstring

地域 ID。

cn-beijing
ServiceNamestring

微服务名称,又称为应用名称。

service 1
OperationNamestring

Span 名称,即某个跟踪点或埋点的名称。

/api
MinDurationlong

大于某个时间跨度范围,单位为毫秒(ms)。例如,200 表示大于 200 毫秒的数据。

2
AppTypestring

应用类型,取值为空或XTRACE,推荐设置为空。

  • 空:查询 XTRACE 和 ARMS 调用链。

  • XTRACE:只查询 XTRACE 调用链。

XTRACE
PageNumberinteger

页码,例如,5 表示第 5 页。

1
PageSizeinteger

每页的查询数据条数。

20
Reverseboolean

按照时间正序或者倒序排列。默认为false。取值:

  • true:倒序。

  • false :顺序。

false
ServiceIpstring

Span 对应主机的 IP 地址。

192.163.XXX.XXX
Tagarray<object>

标签列表。

object

标签列表。

Keystring

标签键。

http.status_cod
Valuestring

标签值。

200

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1E2B6A4C-6B83-4062-8B6F-AEEC1F******
PageBeanobject

返回数据的位置信息。

PageSizeinteger

每页显示的数据条数。

20
PageNumberinteger

页码。

1
TotalCountlong

总条数。

500
TraceInfosarray<object>

返回的调用链信息。

TraceInfoobject

返回的调用链信息。

OperationNamestring

Span 名称。

/api
ServiceIpstring

Span 所在的主机 IP 地址或主机名称。

192.163.XXX.XXX
Durationlong

耗时,单位为毫秒(ms)。

500
Timestamplong

Span 产生时间,单位为毫秒(ms)。

1714306014000
ServiceNamestring

微服务名称,又称为应用名称。

service1
TraceIDstring

调用链 ID。

1c6881aab841******
TagMapobject

标签信息。

{"env":"dev"}

示例

正常返回示例

JSON格式

{
  "RequestId": "1E2B6A4C-6B83-4062-8B6F-AEEC1F******",
  "PageBean": {
    "PageSize": 20,
    "PageNumber": 1,
    "TotalCount": 500,
    "TraceInfos": {
      "TraceInfo": [
        {
          "OperationName": "/api",
          "ServiceIp": "192.163.XXX.XXX",
          "Duration": 500,
          "Timestamp": 1714306014000,
          "ServiceName": "service1",
          "TraceID": "1c6881aab841******",
          "TagMap": {
            "env": "dev"
          }
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史