更新时间:2022-02-21 GMT+08:00

查询调用链

功能介绍

根据查询条件,查询调用链数据。

URI

GET /v1/{projectId}/ats/traces

请求消息

路径参数

路径参数如表1 路径参数所示。

表1 路径参数

参数

参数类型

描述

projectId

String

工程ID

请求参数

请求参数如表2 请求参数所示。

表2 请求参数

参数

是否必选

取值类型

取值范围

描述

startTime

Integer

<endTime

调用链查询开始时间(单位ms)

endTime

Integer

>startTime

调用链查询结束时间(单位ms)

application

String

参见查询服务列表

服务名称

服务名称中的英文字母必须小写,如:“test-service”

monitorGroup

String

参见查询应用列表

应用名称

instance

String

参见查询服务实例列表

实例名称

实例名称中的英文字母必须小写,如:“test-service-4195149926-0fvhn”

transaction

String

参见查询服务事务列表

事务名称, 如:“GET_/rest/healthz/*”

limit

Integer

<=1000,>0的整数

默认为20,单次查询返回的条数限制,最大单次返回1000条

duration

Integer

>=0的整数

默认为0,调用链最小耗时(单位ms)

status

Integer

1:事务执行失败

事务状态,默认查询所有状态的数据,为1时查询调用失败的数据

请求示例

/v1/0/ats/traces?startTime=1506214200000&endTime=1506214428000&application=datamgmtservice&monitorGroup=apm&limit=1

响应消息

响应参数

响应参数如表3 响应参数所示。

表3 响应参数

参数

参数类型

描述

errorCode

String

响应错误码,

SVCSTG.ATS.2000:查询成功

SVCSTG.ATS.400101:参数校验失败

SVCSTG.ATS.200103:没有找到调用链数据

errorMessage

String

响应错误信息描述

responseInfo

result

调用链查询结果

表4 result字段数据结构说明

参数

参数类型

描述

count

Integer

本次查询到的调用链数量

traceChains

List<TraceChainBase>

调用链数据集合

表5 TraceChainBase字段数据结构说明

参数

参数类型

描述

traceId

String

调用链的ID,全局唯一

type

String

服务类型

status

Integer

调用返回状态

duration

Integer

业务调用耗时(单位μs)

application

String

服务名称

instance

String

实例名称

transaction

String

业务调用接口/业务名称

startTime

Integer

业务调用开始时间(单位μs)

endTime

Integer

业务调用结束时间(单位μs)

address

String

调用发起端IPV4地址

响应示例

{
  "errorCode": "SVCSTG.ATS.2000",
  "errorMessage":null,
  "responseInfo": {
    "count": 1,
    "traceChains": [
      {
        "traceId": "000000004fa102d1",
        "type": "TOMCAT_METHOD",
        "status": 0,
        "duration": 10000,
        "application": "datamgmtservice",
        "instance": "datamgmtservice-4267750592-2ngmz",
        "transaction": "/rest/plat/sysmgr/v1/sysagent/alarm/report",
        "startTime": 1506214214095000,
        "endTime": 1506214214105000,
        "address": "192.168.0.1"
      }
    ]
  }
}

状态码

  • 正常
    状态码如表6 状态码所示。
    表6 状态码

    状态码

    描述

    200

    请求响应成功