帮你快速理解、总结文档立即下载
文档中心>Agent Runtime>API 文档>会话管理相关接口>查询会话空间列表

查询会话空间列表

最近更新时间：2026-09-24 01:08:54
我的收藏

本页目录：

1. 接口描述

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

分页查询当前应用和地域下的会话空间。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSessionSpaces。
Version 是 String 公共参数，本接口取值：2025-09-20。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。
Offset 否 Integer

分页查询的起始偏移量。


示例值：0
Limit 否 Integer

单次分页查询返回的会话空间数量。


示例值：20
Filters.N 否 Array of Filter

会话空间筛选条件列表，支持按空间 ID 精确匹配、名称精确或模糊匹配、描述模糊匹配。同一 Filter 内多个 Values 之间为 OR，不同 Filter 之间为 AND。不传或传空数组时不增加筛选限制。

入参限制：Filter.Name 支持 space-id、name、name-like、description-like，不可重复。name 与 name-like 不可同时提供。Values 不可为空数组，筛选值不可为空或纯空白。匹配区分大小写，包含匹配中的 %、_ 按普通字符处理，不具有通配含义。

例如 Name 为 name-like，Values 为 ["客服","测试"]，表示查询名称包含“客服”或“测试”的会话空间。

3. 输出参数

参数名称 类型 描述
SessionSpaces Array of SessionSpaceInfo

会话空间列表。
TotalCount Integer

满足查询条件的会话空间总数。


示例值：3
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分页查询会话空间

查询当前应用及地域下的会话空间列表，每页返回 20 条数据。

输入示例

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

{
    "Offset": 0,
    "Limit": 20
}

输出示例

{
    "Response": {
        "SessionSpaces": [
            {
                "CreateTime": "2026-08-17T03:51:17.608Z",
                "Default": false,
                "Description": "Reserved for sessions generated during a seasonal marketing campaign.",
                "Name": "Seasonal Campaign Temporary Space",
                "SpaceId": "space-22eed49f-e3ae-4b4a-8efa-4cd961bf4764",
                "Status": "Active",
                "UpdateTime": "2026-08-17T03:51:17.608Z"
            }
        ],
        "TotalCount": 3,
        "RequestId": "9d08f066-c47e-4e5d-ae9c-a51d7edf01a6"
    }
}

示例2 按描述筛选会话空间

使用 description-like 筛选描述中包含“DSH Brain Session cookbook”的会话空间，返回匹配的空间列表及总数。

输入示例

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

{
    "Filters": [
        {
            "Name": "description-like",
            "Values": [
                "DSH Brain Session cookbook"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "SessionSpaces": [
            {
                "CreateTime": "2026-09-03T08:03:05.279Z",
                "Default": false,
                "Description": "DSH Brain Session cookbook Chongqing validation",
                "Name": "dsh-session-cq-09031603",
                "SpaceId": "space-04664885-bd66-4a51-83f5-5f6132f8642a",
                "Status": "Active",
                "UpdateTime": "2026-09-03T08:03:05.279Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "de553d46-8094-4644-a68b-ed6b3db7b07c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.InternalError InternalError.InternalError
InvalidParameter.InvalidParameter InvalidParameter.InvalidParameter
中国站