全部产品
Search

搜索本产品

    应用实时监控服务ARMS：SearchTraces - 查询调用链列表信息

    文档中心

    应用实时监控服务ARMS：SearchTraces - 查询调用链列表信息

    更新时间：Nov 05, 2024

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

    接口说明

    说明 该接口最多返回 100 条数据。如需查询全量数据，建议使用 SearchTracesByPage。具体详情，请参见 SearchTracesByPage 。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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
    Pidstring否

    应用 ID。

    		b590lhguqs@9781be0f44dXXXX
    Tagarray<object>否

    标签列表。

    object否
    Keystring否

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

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

    Tag 的值。

    		200
    ExclusionFiltersarray<object>否

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

    object否
    Keystring否

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

    		http.status_code
    Valuestring否

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

    		404

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID

    		4C518054-852F-4023-ABC1-4AF95FF7****
    TraceInfosarray<object>

    返回的调用链路详细信息

    TraceInfoobject
    OperationNamestring

    埋点的接口名称

    		get***
    ServiceIpstring

    应用所在机器的 IP 地址

    		172.20.**.**
    Durationlong

    调用链路耗时（毫秒）

    		6
    Timestamplong

    时间戳

    		1595174436993
    ServiceNamestring

    应用名称

    		arms-k8s-demo-subcomponent
    TraceIDstring

    调用链路 ID

    		ac1400a115951744369937024d****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "4C518054-852F-4023-ABC1-4AF95FF7****",
  "TraceInfos": [
    {
      "OperationName": "get***",
      "ServiceIp": "172.20.**.**",
      "Duration": 6,
      "Timestamp": 1595174436993,
      "ServiceName": "arms-k8s-demo-subcomponent",
      "TraceID": "ac1400a115951744369937024d****",
      "SpanID": ""
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-10-08OpenAPI 返回结构发生变更查看变更详情