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

查询调用链详情

功能介绍

根据调用链的traceId信息查询调用链详情。

URI

GET /v1/{projectId}/ats/spans

请求消息

路径参数

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

表1 路径参数

参数

参数类型

描述

projectId

String

工程ID

请求参数

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

表2 请求参数

参数

是否必选

取值类型

取值范围

描述

traceId

String

从查询的调用链数据中获取

调用链的ID

请求示例

/v1/0/ats/spans?traceId=0000000027046b00

响应消息

响应参数

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

表3 响应参数

参数

参数类型

描述

errorCode

String

响应错误码,

SVCSTG.ATS.2000:查询成功

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

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

errorMessage

String

响应错误信息描述

responseInfo

List(String),数据结构参见(表4 spans字段数据结构说明)

调用链查询结果

表4 spans字段数据结构说明

参数

参数类型

描述

traceId

String

调用链ID,全局唯一

name

String

服务名称:实例名称:事务名称

id

String

Span的ID

parentId

String

当前Span的上级Span ID信息

timestamp

Integer

调用的起始时间(单位μs)

duration

Integer

Span调用耗时(单位μs)

annotations

List(String),数据结构参见(表5 Annotation字段数据结构说明)

调用中客户端或服务端服务信息描述

binaryAnnotations

List(String),数据结构参见(表6 BinarryAnnotation字段数据结构说明)

调用中的扩展信息描述

表5 Annotation字段数据结构说明

参数

参数类型

描述

timestamp

Integer

某事件发生的本地当前系统时间(单位μs)

endpoint

数据结构参见表7 EndPoint字段数据结构说明

调用端服务信息描述,可选

value

String

调用事件类型,取值范围{CS、SR、SS、CR},CS标识客户端发送事件,CR标识客户端接收事件,SR标识服务端接收事件,SS标识服务端发送事件

表6 BinarryAnnotation字段数据结构说明

参数

参数类型

描述

key

String

扩展信息的名称

endpoint

数据结构参见表7

调用端服务信息描述,可选

value

String

扩展信息的值

表7 EndPoint字段数据结构说明

参数

参数类型

描述

serviceName

String

调用端服务名称,可选

ipv4

String

调用端服务IP信息,可选

port

String

调用端服务接口信息,可选

响应示例

{
  "errorCode": "SVCSTG.ATS.2000",
  "errorMessage":null,
  "responseInfo": [
    "{\"traceId\":\"0000000027046b00\",\"id\":\"b42460f5cf86cab4\",\"name\":\"aos-apiserver:aos-apiserver-1005774711-ll63p:/api/v1/namespaces/manage/pods\",\"timestamp\":1506260836597000,\"duration\":67000,\"annotations\":[{\"timestamp\":1506260836597000,\"value\":\"cs\",\"endpoint\":{\"serviceName\":\"aos-apiserver\",\"ipv4\":\"10.186.60.43\",\"port\":6443}},{\"timestamp\":1506260836664000,\"value\":\"cr\",\"endpoint\":{\"serviceName\":\"aos-apiserver\",\"ipv4\":\"10.186.60.43\",\"port\":6443}}],\"binaryAnnotations\":[{\"key\":\"append\",\"value\":\"GET\"},{\"key\":\"async\",\"value\":\"0\"},{\"key\":\"goid\",\"value\":\"58\"},{\"key\":\"result\",\"value\":\"0\"},{\"key\":\"resultCode\",\"value\":\"200\"},{\"key\":\"seqno\",\"value\":\"1506260836597048618\"},{\"key\":\"type\",\"value\":\"1\"}]}"
  ]
}

状态码

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

    状态码

    描述

    200

    请求响应成功