文档

SearchTracesByPage - 分页查询调用链列表信息

更新时间:

分页查询调用链列表信息,可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。

调试

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

授权信息

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

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

请求参数

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

开始时间的时间戳,精确到毫秒。

1595174400000
EndTimelong

结束时间的时间戳,精确到毫秒。

1595210400000
RegionIdstring

地域 ID。

cn-hangzhou
ServiceNamestring

应用名称。

arms-k8s-demo-subcomponent
OperationNamestring

埋点的接口名称。

/demo/queryNotExistDB/11
MinDurationlong

最小耗时,单位为毫秒。

2
Reverseboolean

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

  • true:表示倒序
  • false:表示正序
false
ServiceIpstring

应用所在机器的 IP 地址。

172.20.XX.XX
PageNumberinteger

查询分页的页码。

1
PageSizeinteger

查询分页的每页项目数量,最大值为 100。

5
Pidstring

应用 ID。

b590lhguqs@9781be0f44dXXXX
ExclusionFiltersobject []

用于排除的筛选条件的结构体。

Keystring

用于排除的筛选条件的主键。

http.status_code
Valuestring

用于排除的筛选条件的值。

404
Tagsobject []

标签列表。

Keystring

Tag 的主键。系统预置字段如下:

  • traceId:调用链 ID
  • serverApp:服务端应用名
  • clientApp:客户端应用名
  • service:接口名称
  • rpc:调用类型
  • msOfSpan:耗时大于
  • clientIp:客户端 IP
  • serverIp:服务端 IP
  • isError:是否异常调用
http.status_code
Valuestring

Tag 的值。

200
IsErrorboolean

是否过滤错误的调用链。

  • true:过滤
  • false(默认):不过滤
false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

4C518054-852F-4023-ABC1-4AF95FF7****
PageBeanobject

返回结构体。

PageNumberinteger

返回结果的页码。

1
PageSizeinteger

返回结果的每页项目数量。

5
Totalinteger

返回结果的总项目数量。

1601
TraceInfosobject []

返回的调用链路详细信息。

OperationNamestring

埋点的接口名称。

/demo/queryException/12
ServiceIpstring

应用所在机器的 IP 地址。

172.20.XX.XX
Durationlong

调用链路耗时,单位为毫秒。

679
Timestamplong

时间戳。

1595174436994
ServiceNamestring

应用名称。

arms-k8s-demo-subcomponent
TraceIDstring

调用链路 ID。

ac1400a115951744369947025d****

示例

正常返回示例

JSON格式

{
  "RequestId": "4C518054-852F-4023-ABC1-4AF95FF7****",
  "PageBean": {
    "PageNumber": 1,
    "PageSize": 5,
    "Total": 1601,
    "TraceInfos": [
      {
        "OperationName": "/demo/queryException/12",
        "ServiceIp": "172.20.XX.XX",
        "Duration": 679,
        "Timestamp": 1595174436994,
        "ServiceName": "arms-k8s-demo-subcomponent",
        "TraceID": "ac1400a115951744369947025d****"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-14OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:IsError
  • 本页导读 (1)