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

应用性能监控全链路版

复制全文
下载 pdf
Trace 分析
ListSpan
复制全文
下载 pdf
ListSpan
获取 Span 列表。​
请求说明​
应用性能监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-server.cn-beijing.volcengineapi.com?Action=ListSpan&Version=2026-01-01​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListSpan​
接口名称。当前 API 的名称为 ListSpan。​
Version​
String​
是​
2026-01-01​
接口版本。当前 API 的版本为 2026-01-01。​
StartTime​
Long​
是​
1767196800​
查询起始时间戳,单位:秒。​
EndTime​
Long​
是​
1767200400​
查询结束时间戳,单位:秒。​
Filters​
Array of FilterCondition​
是​
-​
通用过滤条件,对应页面中的筛选框。​
一个 Item 由 key、op、value 组成,例如:span_type,in,server。无筛选时可以传空列表。​
Order​
String​
是​
DESC​
排序顺序,可选值:​
  • ASC:升序排序,按照指定列的值从小到大的顺序排列数据。​
  • DESC:降序排序,按照指定列的值从大到小的顺序排列数据。​
说明​
允许为空。配置为空字符串时,默认为 DESC。​
OrderBy​
String​
是​
duration_microseconds​
排序字段。可选值:​
  • start_time_millisecond:开始时间。​
  • duration_microseconds:耗时。​
说明​
允许为空。配置为空字符串时,默认为 start_time_millisecond。​
Offset​
Integer​
是​
10​
查询结果起始位置。例如配置为 10 时,表示跳过前 10 条数据。​
Limit​
Integer​
是​
30​
查询结果条数。​
ProjectName​
String​
否​
default​
项目名称。​
TagFilters​
Array of TagFilter​
是​
-​
Tag 过滤条件。通过键值对形式配置,对应页面中的标签筛选功能。​
BusinessCarrier​
String​
否​
agentkit_runtime​
业务载体,可选值包括:agentkit_runtime。​
注意​
配置为 agentkit_runtime时,ProjectName 和 TagFilters 参数的取值不生效。​
​
FilterCondition​
​
参数​
类型​
是否必选​
示例值​
描述​
Op​
String​
否​
in​
过滤条件操作符,一般为 in, not_in。​
Key​
String​
否​
call_service_type​
过滤条件的键。​
Values​
Array of String​
否​
['http']​
过滤条件的值。​
​
TagFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Key​
String​
否​
testKey​
过滤 Tag 的键。​
Values​
Array of String​
否​
['testValue']​
过滤 Tag 的值。​
​
请求示例​
​
POST https://apmplus-server.cn-beijing.volcengineapi.com?Action=ListSpan&Version=2026-01-01​
{​
"StartTime": 1767196800,​
"EndTime": 1767200400,​
"Filters": [​
{​
"Op": "in",​
"Key": "call_service_type",​
"Values": [​
""​
]​
}​
],​
"Order": "DESC",​
"OrderBy": "duration_microseconds",​
"Offset": 10,​
"Limit": 30,​
"ProjectName": "default",​
"TagFilters": [​
{​
"Key": "testKey",​
"Values": [​
""​
]​
}​
],​
"BusinessCarrier": "agentkit_runtime"​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
SpanList​
Array of Span​
-​
Span 列表。​
​
Span​
​
参数​
类型​
示例值​
描述​
PId​
Long​
0​
进程 ID。​
Sql​
String​
SELECT * FROM test WHERE id = 233xxx​
SQL 语句。​
说明​
部分参数会被脱敏。​
Tags​
JSON Map​
{'db.user':'test','db.operation':'SELECT'}​
Span 的各类标签。​
CmdKey​
String​
get test_key​
标识 KV 存储的命令,例如:get xx。​
SpanId​
String​
df5f582b529xxxxx​
该条 Span 对应 ID。​
Status​
Integer​
0​
Span 状态码。​
ApiName​
String​
DemoMethod​
接口名。​
ApiTime​
Long​
1767196800​
服务端接收时间,对应页面的上报时间。​
KeyInfo​
Object of KeyInfo​
-​
Span 的核心执行语句。针对数据库操作展示,值为 SQL 语句;针对 KV 存储操作,值为命令。​
Summary​
String​
GET /mysql -\u003e demo-http-to-grpc-svc:port​
Span 的摘要信息。​
TraceId​
String​
58f56847851be99ea0ff3cxxxxxxxxxx​
对应请求的 Trace Id。​
Hostname​
String​
demo-grpc-server-7f89c4677c-xxxxx​
主机名。​
SpanType​
String​
server​
Span 类型,例如:server、client。​
ErrorList​
Array of TraceErrorInfo​
-​
Span 中错误信息,对应页面中的错误堆栈。​
EventList​
Array of Event​
-​
Span 中的事件列表,对应页面中的事件列表。​
GenAIInput​
String​
Hello​
请求大模型的输入。​
InstanceId​
String​
demo-grpc-server-7f89cxxx-xxx.demo-grpc-server​
实例 ID。​
SqlPattern​
String​
SELECT * FROM test WHERE id = ?​
SQL 语句模式。​
CallApiName​
String​
DemoMethod2​
下游接口名。​
ContainerId​
String​
8c41415391508d5345e3c92bxxxx​
容器 ID。​
GenAIOutput​
String​
Hello! How can I help you today?​
大模型的输出。​
ServiceName​
String​
test-grpc-server​
服务名。​
ServiceType​
String​
rpc​
服务类型。​
ParentSpanId​
String​
1b5430d4ddxxxxx​
父 Span ID。​
OperationName​
String​
demoGrpc.DemoService/DemoMethod​
Span 进行的操作。​
CallServiceName​
String​
test-grpc-server2​
下游服务。​
CallServiceType​
String​
rpc​
下游服务类型。​
CallResourceName​
String​
DemoMethod2​
下游资源名。等价于 call_api_name, resource。​
ProcessStartTime​
Long​
1767196800000000​
进程启动时间,即 create_time。​
DurationMicroseconds​
Long​
1096​
该条 Span 的耗时,单位为微秒。​
StartTimeMicrosecond​
Long​
1767196800000000​
该条 Span 的发生事件,对应页面的起始时间,此字段为微秒精度。​
StartTimeMillisecond​
Long​
1767196800000​
该条 Span 的发生事件,对应页面的起始时间,此字段为毫秒精度。​
​
KeyInfo​
​
参数​
类型​
示例值​
描述​
Value​
String​
SELECT * FROM test WHERE id = 233xxx​
用于标识核心执行语句。​
​
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​
错误标签的值。​
​
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​
事件发生时间,单位:毫秒。​
​
返回示例​
​
{​
"Result": {​
"SpanList": [​
{​
"PId": 0,​
"Sql": "SELECT * FROM test WHERE id = 233xxx", ​
"CmdKey": "get test_key",​
"SpanId": "df5f582b529xxxxx",​
"Status": 0,​
"ApiName": "DemoMethod",​
"ApiTime": 1767196800,​
"KeyInfo": {​
"Value": "SELECT * FROM test WHERE id = 233xxx"​
},​
"Summary": "GET /mysql -\\u003e demo-http-to-grpc-svc:port",​
"TraceId": "58f56847851be99ea0ff3cxxxxxxxxxx",​
"Hostname": "demo-grpc-server-7f89c4677c-xxxxx",​
"SpanType": "server",​
"ErrorList": [​
{​
"IssueId": "b7d963c267c30e7c5ddexxxx",​
"ErrorKind": "UncaughtException",​
"ErrorStack": "java.lang.RuntimeException: Node not found\\n\\tat com.example.grpcserver.xxx.demoMethod(xxx.java:34)\\....",​
"ErrorMessage": "Node not found",​
"ErrorOccurTime": 1767196800​
}​
],​
"EventList": [​
{​
"TraceId": "58f56847851be99ea0ff3cxxxxxxxxxx",​
"Tags": "{'message.id':'1.0','message.type':'RECEIVED'}",​
"EventName": "message",​
"ServiceName": "demo-service",​
"OperationName": "Get",​
"EventTimeMillisecond": 1767196800000​
}​
],​
"GenAIInput": "Hello",​
"InstanceId": "demo-grpc-server-7f89cxxx-xxx.demo-grpc-server",​
"SqlPattern": "SELECT * FROM test WHERE id = ?",​
"CallApiName": "DemoMethod2",​
"ContainerId": "8c41415391508d5345e3c92bxxxx",​
"GenAIOutput": "Hello! How can I help you today?",​
"ServiceName": "test-grpc-server",​
"ServiceType": "rpc",​
"ParentSpanId": "1b5430d4ddxxxxx",​
"OperationName": "demoGrpc.DemoService/DemoMethod",​
"CallServiceName": "test-grpc-server2",​
"CallServiceType": "rpc",​
"CallResourceName": "DemoMethod2",​
"ProcessStartTime": 1767196800000000,​
"DurationMicroseconds": 1096,​
"StartTimeMicrosecond": 1767196800000000,​
"StartTimeMillisecond": 1767196800000​
}​
]​
},​
"ResponseMetadata": {​
"Action": "ListSpan",​
"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.09.16 14:24:23
这个页面对您有帮助吗?
有用
有用
无用
无用