文档

GetTrace - 获取调用链详情

更新时间:

加快获取调用链详情。

接口说明

说明 Java SDK 需更新至版本 v2.7.24。

调试

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

授权信息

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

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

请求参数

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

调用链 ID。可在 ARMS 控制台的调用链路查询页面或接口快照页面获取。

ac14001a15954493811405707d****
RegionIdstring

地域 ID。

cn-hangzhou
StartTimelong

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

说明 若 TraceID 长度为 30,可不填;若 TraceID 长度不是 30,则必填。
1623827602000
EndTimelong

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

说明 若 TraceID 长度为 30,可不填;若 TraceID 长度不是 30,则必填。
1623827603000

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6A9AEA84-7186-4D8D-B498-4585C6A2****
Spansarray<object>

调用链路详细信息。

object
SpanIdstring

Span ID。

1234
OperationNamestring

埋点的接口名称。

/api/demo
ResultCodestring

返回码。

222
Timestamplong

Span 的产生时间戳。

1590388651
RpcTypeinteger

RPC 类型:

  • -2 front
  • -3 app
  • 0 http
  • 25 http_client
  • 1 hsf_client
  • 2 hsf
  • 40 local
  • 41 async
  • 52 DB2
  • 53 Informix
  • 54 SequoiaDB
  • 55 Gbase
  • 56 GaussDB
  • 57 KingBase
  • 58 infuxdb
  • 59 clickhouse
  • 60 mysql
  • 61 mysql
  • 62 oracle
  • 63 postgresql
  • 64 mongodb
  • 65 ppas
  • 66 sqlserver
  • 67 mariadb
  • 68 dmdb
  • 69 oceanbase
  • 70 redis
  • 71 memcached
  • 72 elasticsearch
  • 73 kudu
  • 4 tddl
  • 5 tair
  • 13 mq_client
  • 252 mq
  • 23 kafka_client
  • 256 kafka
  • 3 notify_client
  • 254 notify
  • 7 dubbo_client
  • 8 dubbo
  • 11 dsf_client
  • 12 dsf
  • 9 grpc
  • 10 grpc_client
  • 16 thrift
  • 17 thrift_client
  • 18 sofa
  • 19 sofa_client
  • -1 unknown
  • 98 user_method
  • 100 root
  • 101 client
  • 102 server
  • 103 producer
  • 104 consumer
  • 105 db
  • 106 xtrace_other
  • 1301 schedulerx
  • 1302 XXL_Job
  • 1303 Spring_Scheduled
  • 1304 Quartz
  • 1305 ElasticJob
  • 1308 Jdk_Timer
1
ServiceIpstring

应用所在机器的 IP 地址。

172.20.XX.XX
HaveStackboolean

是否有方法栈:

  • true:有方法栈。
  • false:没有方法栈。
false
ParentSpanIdstring

父 Span ID。

18
Durationlong

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

1000
RpcIdstring

RPC ID。

0
ServiceNamestring

应用名称。

arms-demo
TraceIDstring

调用链路 ID。

ac14001a15954493811405707d****
TagEntryListarray<object>

调用链路的 Tag 列表。

object
Keystring

Tag 的键。

http.status.code
Valuestring

Tag 的值。

200
LogEventListarray<object>

调用链路中的日志事件。

object
Timestamplong

日志事件的产生时间戳。

1590388651
TagEntryListarray<object>

调用链路的 Tag 列表。

object
Keystring

Tag 的键。

http.status.code
Valuestring

Tag 的值。

200
Childrenarray<object>

当前 Span 的子 Span 的列表。

object

子 Span 详情。

[ { "ParentSpanId":"c33603355032xxxx", "ServiceIp":"10.208.xxx.xxx", "OperationName":"/product/toy/8ac7ddeb-1c3c-4911-850c-665a5a0xxxx", "RpcType":0, "Duration":2, "TagEntryList":[ { "Value":"10.208.0.xxx", "Key":"source.ip" } ], "Timestamp":1652669026201, "HaveStack":true, "LogEventList":[ ], "ServiceName":"xxxxxx", "RpcId":"0.2", "TraceID":"ea1ad000a1165266902619685xxxxx", "Children":[ ], "ResultCode":"0", "SpanId":"7069ab30d7cbxxxx" } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "6A9AEA84-7186-4D8D-B498-4585C6A2****",
  "Spans": [
    {
      "SpanId": "1234",
      "OperationName": "/api/demo",
      "ResultCode": "222",
      "Timestamp": 1590388651,
      "RpcType": 1,
      "ServiceIp": "172.20.XX.XX",
      "HaveStack": false,
      "ParentSpanId": "18",
      "Duration": 1000,
      "RpcId": "0",
      "ServiceName": "arms-demo",
      "TraceID": "ac14001a15954493811405707d****",
      "TagEntryList": [
        {
          "Key": "http.status.code",
          "Value": "200"
        }
      ],
      "LogEventList": [
        {
          "Timestamp": 1590388651,
          "TagEntryList": [
            {
              "Key": "http.status.code",
              "Value": "200"
            }
          ]
        }
      ],
      "Children": [
        [
          {
            "ParentSpanId": "c33603355032xxxx",
            "ServiceIp": "10.208.xxx.xxx",
            "OperationName": "/product/toy/8ac7ddeb-1c3c-4911-850c-665a5a0xxxx",
            "RpcType": 0,
            "Duration": 2,
            "TagEntryList": [
              {
                "Value": "10.208.0.xxx",
                "Key": "source.ip"
              }
            ],
            "Timestamp": 1652669026201,
            "HaveStack": true,
            "LogEventList": [],
            "ServiceName": "xxxxxx",
            "RpcId": "0.2",
            "TraceID": "ea1ad000a1165266902619685xxxxx",
            "Children": [],
            "ResultCode": "0",
            "SpanId": "7069ab30d7cbxxxx"
          }
        ]
      ]
    }
  ]
}

错误码

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

变更历史

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