Agent Runtime 会话列表

1. 接口描述

接口请求域名： ags.tencentcloudapi.com 。

查询会话列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSessions。
Version	是	String	公共参数，本接口取值：2025-09-20。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。
SpaceId	是	String	查询的会话空间 ID。示例值：space-75f28517-9fb3-4234-9530-afa323f496bc
UserIds.N	否	Array of String	用户 ID 列表，最多支持 100 个。示例值：["u_8697b7b61a4d2d3e678f"]
Offset	否	Integer	分页偏移量，默认为 0。示例值：0
Limit	否	Integer	返回数量，默认为 20，最大值为 100。示例值：10
SessionIds.N	否	Array of String	会话 ID 列表，最多支持 100 个。示例值：["s-1782874989487-b38jan"]
Filters.N	否	Array of Filter	会话筛选条件列表，支持 Metadata 精确匹配、标题精确匹配和标题模糊匹配。同一 Filter 内多个 Values 之间为 OR，不同 Filter 之间为 AND。不传或传空数组时不增加筛选限制。入参限制：最多传入 10 个 Filter，每个 Filter 最多支持 100 个 Values。Filter.Name 不可重复，支持 metadata:MetadataKey、title、title-like；title 与 title-like 不可同时提供。标题筛选值不可为空或纯空白。匹配区分大小写，标题包含匹配中的 %、_ 按普通字符处理，不具有通配含义。例如 Name 为 title-like，Values 为 ["客服","测试"]，表示查询标题包含“客服”或“测试”的会话。Name 为 metadata:env，Values 为 ["dev","test"]，表示按 Metadata env 的值精确筛选。标题条件与 Metadata、SessionIds、UserIds 筛选条件可组合使用，条件之间为 AND。筛选在分页前执行，TotalCount 为符合条件的会话总数。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的会话总数。示例值：1
Sessions	Array of SessionInfo	会话列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 按 Metadata 过滤 Session

查询 Metadata 中 env 字段值为 dev 的 Session 列表。

输入示例

POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSessions
<公共请求参数>

{
    "SpaceId": "space-75f28517-9fb3-4234-9530-afa323f496bc",
    "Filters": [
        {
            "Name": "metadata:env",
            "Values": [
                "dev"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Sessions": [
            {
                "CreateTime": "2026-09-02T08:00:03Z",
                "EventCount": 0,
                "Metadata": [
                    {
                        "Name": "env",
                        "Value": "dev"
                    }
                ],
                "SessionId": "ffa6e867-a315-447e-917b-ba01ea557c02",
                "SpaceId": "space-75f28517-9fb3-4234-9530-afa323f496bc",
                "Title": "modify titile",
                "UpdateTime": "2026-09-02T08:08:23Z",
                "UserId": "0001"
            }
        ],
        "TotalCount": 1,
        "RequestId": "823e1eb7-3b87-459c-a239-cfe1efafcd32"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
ResourceNotFound.SessionSpaceNotExist	指定的会话空间不存在，或不属于当前应用及地域。

会话列表

本页目录：