获取项目下的用户列表

最近更新时间:2025-03-04 01:31:10

我的收藏

1. 接口描述

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

获取项目下的用户,分页返回

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProjectUsers。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
PageNumber Integer 分页号
示例值:0
PageSize Integer 分页大小
示例值:10
Filters.N Array of FilterOptional 【过滤参数】自定义条件查询
示例值:1
OrderFields.N Array of OrderFieldOptional 【排序参数】排序字段
示例值:1
IsProjectAdmin Boolean 是否项目管理员

3. 输出参数

参数名称 类型 描述
Data ProjectUsersPage 项目列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例2

查询项目下用户

输入示例

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

{
    "PageNumber": "0",
    "PageSize": "10"
}

输出示例

{
    "Response": {
        "Data": {
            "PageNumber": 0,
            "PageSize": 1,
            "Rows": [
                {
                    "AppId": null,
                    "CreateTime": "2024-08-14T17:48:55+08:00",
                    "Creator": true,
                    "DisplayName": "peterpksong",
                    "Email": null,
                    "IsProjectAdmin": true,
                    "OwnerUin": null,
                    "PhoneNum": null,
                    "Roles": [
                        {
                            "Description": null,
                            "MethodPaths": null,
                            "Name": "ProjectManager",
                            "NameCn": "项目管理员",
                            "Params": null,
                            "Privileges": null,
                            "RoleId": "308335260274237440",
                            "RoleType": null,
                            "SystemInit": null
                        }
                    ],
                    "UserId": "100028694266",
                    "UserName": "peterpksong"
                }
            ],
            "TotalCount": 2,
            "TotalPageNumber": 2
        },
        "RequestId": "477b3ec7-afe2-4d3d-a772-52100d60d668"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。