文档中心

应用性能监控全链路版

会话分析

ListSession

获取会话列表。

请求说明

应用性能监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://apmplus-server.cn-beijing.volcengineapi.com?Action=ListSession&Version=2026-01-01

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListSession	接口名称。当前 API 的名称为 ListSession。
Version	String	是	2026-01-01	接口版本。当前 API 的版本为 2026-01-01。
StartTime	Long	是	1767196800000	查询开始时间的时间戳，单位：毫秒。
EndTime	Long	是	1767200400000	查询结束时间的时间戳，单位：毫秒。
Filters	Array of FilterCondition	是	[{"key":"user_id","op":"in","values":["u123"]}]	会话过滤条件。取值： session_id：会话 ID user_id：用户 ID service：会话所属服务 trace_count：Trace 数量 input_tokens：会话输入 Token 数 output_tokens：会话输出 Token 数 total_tokens：会话总 Token 数 duration：会话持续时间 session_start_time：会话开始时间
ProjectName	String	否	default	项目名称。
TagFilters	Array of TagFilter	是	[{"key":"env","values":["prod"]}]	Tag 过滤条件。
PageNo	Integer	是	1	分页页码，从第 1 页开始。无默认值，请配置正整数。
PageSize	Integer	是	20	每页会话数。无默认值，请配置正整数。
OrderBy	String	否	session_start_time	排序字段。取值 session_start_time（默认值）：会话开始时间 duration：会话持续时间 trace_count：Trace 数量 input_tokens：会话输入 Token 数 output_tokens：会话输出 Token 数 total_tokens：会话总 Token 数 session_id：会话 ID user_id：用户 ID service：会话所属服务
Order	String	否	desc	排序方向。取值： asc：升序排列 desc：降序排列（默认值）
BusinessCarrier	String	否	agentkit_runtime	业务载体，用于根据业务载体筛选关联服务。示例值： agentkit_runtime arkclaw_enterprise arkclaw_personal arkclaw_omni
Workspace	String	否	default	工作区。应用性能监控提供的数据管理和数据隔离方式，每个工作区拥有独立的数据上报凭证，可针对不同应用归属特性，将对应的链路、日志、指标数据做统一管理。

FilterCondition

参数	类型	是否必选	示例值	描述
Op	String	否	in	操作符。取值： gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
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=ListSession&Version=2026-01-01​
{​
    "StartTime": 1767196800000,​
    "EndTime": 1767200400000,​
    "Filters": [​
        {​
            "key": "user_id",​
            "op": "in",​
            "values": [​
                "u123"​
            ]​
        }​
    ],​
    "ProjectName": "default",​
    "TagFilters": [​
        {​
            "key": "env",​
            "values": [​
                "prod"​
            ]​
        }​
    ],​
    "PageNo": 1,​
    "PageSize": 20,​
    "OrderBy": "session_start_time",​
    "Order": "desc",​
    "BusinessCarrier": "agentkit_runtime",​
    "Workspace": "default"​
}

返回参数

参数	类型	示例值	描述
TotalCount	Integer	128	查询结果总数，用于分页。
SessionBriefs	Array of SessionBrief	[{"session_id":"sess_001","input_tokens":120,"output_tokens":300,"total_tokens":420,"trace_ids":["trace_001"],"user_id":"u123","session_start_time":1767196801000,"session_end_time":1767196815000,"workspace":"default"}]	会话摘要列表。

SessionBrief

参数	类型	示例值	描述
UserId	String	u123	用户 ID。
TraceIds	Array of String	["trace_001","trace_002"]	Trace ID 列表。
SessionId	String	sess_001	会话 ID。
Workspace	String	default	工作区。
InputTokens	Integer	120	会话输入 Token 数。
TotalTokens	Integer	420	会话总 Token 数。
OutputTokens	Integer	300	会话输出 Token 数。
SessionEndTime	Long	1767196815000	会话最后调用时间的时间戳，单位：毫秒。
SessionStartTime	Long	1767196801000	会话开始时间的时间戳，单位：毫秒。

返回示例

{​
    "Result": {​
        "SessionBriefs": [​
            {​
                "SessionId": "sess_001",​
                "InputTokens": 120,​
                "OutputTokens": 300,​
                "TotalTokens": 420,​
                "TraceIds": [​
                    "trace_001"​
                ],​
                "UserId": "u123",​
                "SessionStartTime": 1767196801000,​
                "SessionEndTime": 1767196815000,​
                "Workspace": "default"​
            }​
        ],​
        "TotalCount": 128​
    },​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "ListSession",​
        "Version": "2026-01-01",​
        "Service": "apmplus_server",​
        "Region": "cn-north-1"​
    }​
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2026.08.21 10:08:12

这个页面对您有帮助吗？

有用

无用