帮你快速理解、总结文档立即下载

查询工作空间用户组用户列表

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

1. 接口描述

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

查询工作空间用户组用户列表

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

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

2. 输入参数

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

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

工作空间id


示例值:17623497097012366
GroupId 是 String

用户组ID,可通过 ListWorkspaceGroups 接口获取


示例值:17667377941556921
NameKeywords 否 String

关键字,支持按用户名模糊搜索


示例值:brian
UserUins.N 否 Array of String

用户UIN列表,按UIN精确筛选


示例值:["700002213764"]
OrderBys.N 否 Array of OrderBy

"OrderBys": [{"Name": "CreateTime", "Direction": "DESC" }]

PageNumber 否 Integer

页码,从1开始,默认1


示例值:1
PageSize 否 Integer

每页大小

取值范围:[1, 100]

默认值:10


示例值:10

3. 输出参数

参数名称 类型 描述
Data ListWorkspaceGroupUsersRsp

返回结果

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

4. 示例

示例1 ListWorkspaceGroupUsers

查询工作空间用户组用户列表

输入示例

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

{
    "WorkspaceId": "17623497097012366",
    "GroupId": "17667377941556921",
    "NameKeywords": "brian",
    "UserUins": [
        "700002213764"
    ],
    "OrderBys": [
        {
            "Name": "CreateTime",
            "Direction": "DESC"
        }
    ],
    "PageNumber": 1,
    "PageSize": 10
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateTime": "1768306785636",
                    "Nickname": "brian-dev",
                    "UpdateTime": "1783698994446",
                    "UserName": "brian-dev",
                    "UserUin": "700002213764"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 2,
            "TotalPageNumber": 1
        },
        "RequestId": "a9ad9ba2-680b-4b84-9e2d-150c7edceb33"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.UGRUserNotExist 用户不存在
InvalidParameterValue.GroupNotExist 用户组Id不存在
InvalidParameterValue.InvalidGroupId 用户组ID无效
UnsupportedOperation.DeleteSystemGroupFail 系统组不支持删除
UnsupportedOperation.UpdateSystemGroupFail 系统组不支持修改