帮你快速理解、总结文档立即下载
文档中心>API 中心>大数据智能体工作台 DataBuddy>工作空间相关接口>查询工作空间列表

查询工作空间列表

最近更新时间：2026-10-05 01:53:40
我的收藏

本页目录：

1. 接口描述

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

查询工作空间列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ListWorkspaces。
Version 是 String 公共参数，本接口取值：2026-07-15。
Region 是 String 公共参数，详见产品支持的 地域列表。
WorkspaceId 否 String

工作空间ID精确匹配


示例值：17676143448574812
WorkspaceKeyword 否 String

工作空间名称模糊匹配


示例值：example
StatusList.N 否 Array of Integer

工作空间状态过滤（多选）：0=未指定 1=创建中 2=创建失败 3=正常运行中 4=已删除


示例值：[1]
OrderBys.N 否 Array of OrderBy

多字段排序，如 [{Name: 'CreateTime', Direction: 'Desc'}]；传入单个即单字段排序，默认按创建时间降序
PageNumber 否 Integer

页码，从1开始，默认1


示例值：1
PageSize 否 Integer

每页大小，默认10，最小10，最大100


示例值：11
WorkspaceRegion.N 否 Array of String

工作空间地域过滤（多选），如 ap-guangzhou


示例值：["ap-guangzhou"]
Creator.N 否 Array of String

创建者UIN过滤（多选）


示例值：["100044134096"]

3. 输出参数

参数名称 类型 描述
Data ListWorkspacesRsp

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

4. 示例

示例1 示例

输入示例

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

{
    "WorkspaceId": "17676143448574812",
    "WorkspaceKeyword": "example",
    "StatusList": [
        1
    ],
    "PageNumber": 1,
    "PageSize": 11
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [],
            "PageNumber": 1,
            "PageSize": 11,
            "TotalCount": 0,
            "TotalPageNumber": 0
        },
        "RequestId": "53f42163-04ec-4854-bb90-ce71f730e43e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

中国站