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

查询工作空间用户组列表

最近更新时间：2026-10-12 01:54:31
我的收藏

本页目录：

1. 接口描述

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

查询工作空间用户组列表

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

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

2. 输入参数

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

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

工作空间ID


示例值：17851563773633788
GroupIds.N 否 Array of String

通过用户组ID批量查询；用户组ID可通过 ListWorkspaceGroups 接口获取


示例值：["3001"]
GroupKeyword 否 String

用户组名称模糊匹配


示例值：example
RoleIds.N 否 Array of String

用于过滤角色关联的用户组；可通过 ListWorkspaceRoles 接口获取


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

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

页码，从1开始，默认1；小于1时按1处理


示例值：1
PageSize 否 Integer

每页大小，默认10，取值范围为 [1,100]，越界时自动收敛到边界值


示例值：11
GroupType 否 String

用户组类型筛选。取值为枚举数值的字符串形式："0"=控制台系统类型（包含全部user）、"1"=控制台自定义类型、"2"=工作空间系统类型（包含工作空间全部user）、"3"=工作空间自定义类型


示例值：0

3. 输出参数

参数名称 类型 描述
Data ListWorkspaceGroupsRsp

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

4. 示例

示例1 示例

输入示例

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

{
    "WorkspaceId": "17851563773633788",
    "GroupKeyword": "example",
    "RoleIds": [
        "2001"
    ],
    "PageNumber": 1,
    "PageSize": 11,
    "GroupType": "0"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateTime": "",
                    "GroupId": "700002164618",
                    "GroupName": "all_users",
                    "GroupType": "0",
                    "Roles": [],
                    "Tags": [],
                    "UpdateTime": "",
                    "UserCount": 0
                }
            ],
            "PageNumber": 0,
            "PageSize": 0,
            "TotalCount": 0,
            "TotalPageNumber": 0
        },
        "RequestId": "a5c4fc49-defc-4230-b46f-36ce2d2a7168"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

中国站