You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
Trace 分析
GetTraceDetail
复制全文
下载 pdf
GetTraceDetail
获取 Trace 详情。​
请求说明​
应用性能监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-server.cn-beijing.volcengineapi.com?Action=GetTraceDetail&Version=2026-01-01​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetTraceDetail​
接口名称。当前 API 的名称为 GetTraceDetail。​
Version​
String​
是​
2026-01-01​
接口版本。当前 API 的版本为 2026-01-01。​
TraceId​
String​
是​
b7d963cxxxx30e7c5ddexxxx​
待查询的 Trace ID。​
SuggestTime​
Long​
是​
1767196800​
加快查询速度。​
  • 通过时间戳形式配置,若配置此参数,会将搜索的时间范围限制在 SuggestTime 的前后一个小时。​
  • 若无法预估时间范围或不使用加速查询时,配置为 0。​
​
请求示例​
​
POST https://apmplus-server.cn-beijing.volcengineapi.com?Action=GetTraceDetail&Version=2026-01-01​
{​
"TraceId": "b7d963cxxxx30e7c5ddexxxx",​
"SuggestTime": 1767196800​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
Msg​
String​
No data was found in the query​
提示信息,根据实际情况返回。​
Trace​
Object of Trace​
-​
待查询的 Trace 详情,此配置为核心返回数据。​
Summary​
Object of TraceSummaryInfo​
-​
Trace 的摘要统计信息。​
​
Trace​
​
参数​
类型​
示例值​
描述​
Status​
Integer​
0​
Trace 状态码。​
  • 非 HTTP 组件中,0 表示正常,1 表示异常。​
  • HTTP 组件中,等同于 http_status_code,例如:404、500 等。​
ApiName​
String​
DemoMethod​
Trace 的起始接口。​
TraceId​
String​
b7d963c267c30e7c5ddexxxx​
待查询的 Trace ID。​
SpanList​
Array of SpanBrief​
-​
Span 列表的摘要信息。​
ServiceName​
String​
test-grpc-server​
Trace 的起始服务。​
ServiceType​
String​
rpc​
Trace 的起始服务类型。​
DurationMicroseconds​
Long​
1873​
整体耗时,单位:微秒。​
StartTimeMillisecond​
Long​
1767196800000​
开始时间。​
​
SpanBrief​
​
参数​
类型​
示例值​
描述​
Env​
String​
prod​
当前 Span 所属的环境。​
SpanId​
String​
4374f05fb9axxxxx​
Span ID 信息。​
Status​
Integer​
0​
Span 状态码。​
  • 非 HTTP 组件中,0 表示正常,1 表示异常。​
  • HTTP 组件中,等同于 http_status_code,例如:404、500 等。​
ApiName​
String​
DemoMethod​
接口名。​
ApiTime​
Long​
1767196800​
服务端接收时间。​
Hostname​
String​
demo-grpc-server-7f89c4677c-xxxxx​
主机名。​
SpanType​
String​
server​
Span 类型。​
EventList​
Array of Event​
-​
事件列表。​
InputTokens​
Long​
16​
生成 AI Span 的 input token 数。​
ServiceName​
String​
test-grpc-server​
服务名称。​
ServiceType​
String​
rpc​
服务类型。​
TotalTokens​
Long​
166​
生成 AI Span 的总 token 数。​
OutputTokens​
Long​
150​
生成 AI Span 的 output token 数。​
ParentSpanId​
String​
4ce724e472axxxx​
父 Span ID。​
ErrorInfoList​
Array of TraceErrorInfo​
-​
错误信息列表,支持在一个 Span 中查看多个错误。​
GenAISpanKind​
String​
llm​
生成 AI Span 的类型。​
OperationName​
String​
redis.command​
操作名。​
CacheReadTokens​
Long​
100​
生成 AI Span 的 cache read token 数。​
CallServiceType​
String​
rpc​
下游服务类型。​
DurationMicroseconds​
Long​
1096​
耗时,单位:微秒。​
StartTimeMicrosecond​
Long​
1767196800000000​
开始时间,单位:微秒。​
StartTimeMillisecond​
Long​
1767196800000​
开始时间,单位:毫秒。​
RelativeStartTimeMillisecond​
Long​
100​
从请求调用开始到当前 Span 开始的相对时间,单位:毫秒。​
​
Event​
​
参数​
类型​
示例值​
描述​
Tags​
JSON Map​
{'message.id':'1.0','message.type':'RECEIVED'}​
事件标签。​
TraceId​
String​
58f56847851be99ea0ff3cxxxxxxxxxx​
事件所属 TraceID。​
EventName​
String​
message​
事件名。​
ServiceName​
String​
demo-service​
事件所属服务。​
OperationName​
String​
Get​
事件操作名。​
EventTimeMillisecond​
Long​
1767196800000​
事件发生时间,单位:毫秒。​
​
Tags​
​
参数​
类型​
示例值​
描述​
key​
String​
message.type​
事件标签的键。​
value​
String​
RECEIVED​
事件标签的值。​
​
TraceErrorInfo​
​
参数​
类型​
示例值​
描述​
IssueId​
String​
b7d963c267c30e7c5ddexxxx​
错误 ID。​
ErrorKind​
String​
UncaughtException​
错误类型。​
ErrorTags​
JSON Map​
{'error_tag_key':'error_tag_value'}​
错误标签。​
ErrorStack​
String​
java.lang.RuntimeException: Node not found\n\tat com.example.grpcserver.xxx.demoMethod(xxx.java:34)....​
错误堆栈。​
ErrorMessage​
String​
Node not found​
错误消息。​
ErrorOccurTime​
Long​
1767196800​
错误发生时间。​
​
ErrorTags​
​
参数​
类型​
示例值​
描述​
key​
String​
error_tag_key​
错误标签的键。​
value​
String​
error_tag_value​
错误标签的值。​
​
TraceSummaryInfo​
​
参数​
类型​
示例值​
描述​
SpanNums​
Integer​
10​
Span 总数。​
ServiceNums​
Integer​
5​
涉及的服务总数。​
ErrorSpanIds​
Array of String​
['4374f05fb9axxxxx','4ce724e472axxxx']​
错误 Span ID 列表。​
ComponentSpanIds​
JSON Map​
{'kitex':['4374f05fb9axxxxx','4ce724e472axxxx'],'redis':['4374f05fb9axxxxx']}​
组件和组件 Span ID 列表。其中,key 为组件包含中间件、服务调用,value 为 Span ID 列表。​
说明​
不同组件可能包含重复 Span。​
LLMComponentSpanIds​
JSON Map​
{'OpenAI':['4374f05fb9axxxxx','4ce724e472axxxx']}​
大模型组件的统计。其中,key 为大模型组件的 span.kind、gen_ai.system,value 为 Span ID 列表。​
说明​
不同组件可能包含重复 Span。​
​
ComponentSpanIds​
​
参数​
类型​
示例值​
描述​
key​
String​
kitex​
通用组件的键。​
value​
Array of String​
['4374f05fb9axxxxx','4ce724e472axxxx']​
通用组件的值。​
​
LLMComponentSpanIds​
​
参数​
类型​
示例值​
描述​
key​
String​
OpenAI​
大模型组件的键。​
value​
Array of String​
['4374f05fb9axxxxx','4ce724e472axxxx']​
大模型组件的值。​
​
返回示例​
​
{​
"Result": {​
"Msg": "No data was found in the query",​
"Trace": {​
"Status": 0,​
"ApiName": "DemoMethod",​
"TraceId": "b7d963c267c30e7c5ddexxxx",​
"SpanList": [​
{​
"Env": "prod",​
"SpanId": "4374f05fb9axxxxx",​
"Status": 0,​
"ApiName": "DemoMethod",​
"ApiTime": 1767196800,​
"Hostname": "demo-grpc-server-7f89c4677c-xxxxx",​
"SpanType": "server",​
"EventList": [​
{​
"TraceId": "58f56847851be99ea0ff3cxxxxxxxxxx",​
"Tags": "{'message.id':'1.0','message.type':'RECEIVED'}",​
"EventName": "message",​
"ServiceName": "demo-service",​
"OperationName": "Get",​
"EventTimeMillisecond": 1767196800000​
}​
],​
"ServiceName": "test-grpc-server",​
"ServiceType": "rpc",​
"TotalTokens": 166,​
"OutputTokens": 150,​
"ParentSpanId": "4ce724e472axxxx",​
"ErrorInfoList": [​
{​
"IssueId": "b7d963c267c30e7c5ddexxxx",​
"ErrorKind": "UncaughtException",​
"ErrorTags": "{'error_tag_key':'error_tag_value'}",​
"ErrorStack": "java.lang.RuntimeException: Node not found\\n\\tat com.example.grpcserver.xxx.demoMethod(xxx.java:34)\\....",​
"ErrorMessage": "Node not found",​
"ErrorOccurTime": 1767196800​
}​
],​
"GenAISpanKind": "llm",​
"OperationName": "redis.command",​
"CacheReadTokens": 100,​
"CallServiceType": "rpc",​
"DurationMicroseconds": 1096,​
"StartTimeMicrosecond": 1767196800000000,​
"StartTimeMillisecond": 1767196800000,​
"RelativeStartTimeMillisecond": 100​
}​
],​
"ServiceName": "test-grpc-server",​
"ServiceType": "rpc",​
"DurationMicroseconds": 1873,​
"StartTimeMillisecond": 1767196800000​
},​
"Summary": {​
"SpanNums": 10,​
"ServiceNums": 5,​
"ErrorSpanIds": [​
""​
]​
}​
},​
"ResponseMetadata": {​
"Action": "GetTraceDetail",​
"Region": "cn-north-1",​
"Service": "apmplus_server",​
"Version": "2026-01-01",​
"RequestId": "20230604110420****100232280022D31"​
}​
}
​
错误码​
若接口调用返回异常,可参考以下接口错误码和 公共错误码 进行故障排查。​
​
HTTP 状态码​
错误码​
错误信息​
说明​
500​
ErrInternalServerError​
We encountered an unexpected server error, please try again later.​
服务器内部错误。​
​
最近更新时间:2026.02.10 19:56:35
这个页面对您有帮助吗?
有用
有用
无用
无用