管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>数据开发治理平台 WeData>平台管理相关接口>获取角色列表信息

获取角色列表信息

最近更新时间：2025-06-25 01:51:35

我的收藏

本页目录：

1. 接口描述

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

获取角色列表信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRoleList。
Version 是 String 公共参数，本接口取值：2021-08-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
ShowAllRoles 否 Boolean 返回所有角色。
示例值：true
IncludeRoleTypes.N 否 Array of String 需要返回的角色类型(system,tenant,project)
DescribeMemberCount 否 Boolean 返回角色绑定人员统计，仅私有化版本支持
示例值：true
DescribeOperator 否 Boolean 返回操作者信息，私有化多租户版本
示例值：true
DescribeSystemRoleOnly 否 Boolean 系统角色
示例值：false
DescribeCustomRoleOnly 否 Boolean 自定义角色
示例值：false
DescribePrivileges 否 Boolean 查看权限
示例值：false
RoleIds.N 否 Array of String 筛选角色id
ProjectId 否 String 项目id
示例值：123
PageNumber 否 Integer 页码
示例值：1
PageSize 否 Integer 分页信息
示例值：10
Filters.N 否 Array of Filter 查询字段
OrderFields.N 否 Array of OrderFields 排序字段

3. 输出参数

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

4. 示例

示例1 test1

test1

输入示例

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

{
    "ProjectId": "1554879954290339840"
}

输出示例

{
    "Response": {
        "Data": {
            "PageNumber": 1,
            "PageSize": 10,
            "Rows": [
                {
                    "CreateTime": null,
                    "CreateTimeStr": "1600938213660",
                    "Creator": null,
                    "Description": "负责项目日常管理，包括成员添加，角色分配等",
                    "DisplayName": "项目管理员",
                    "MemberCount": null,
                    "OperateTime": null,
                    "Operator": null,
                    "Parameters": null,
                    "Privileges": null,
                    "ProjectId": null,
                    "RoleId": "308335260274237440",
                    "RoleName": "ProjectManager",
                    "RoleType": null,
                    "SystemDefault": null,
                    "UpdateTime": null,
                    "UpdateTimeStr": "1629985314500"
                },
                {
                    "CreateTime": null,
                    "CreateTimeStr": "1600938213684",
                    "Creator": null,
                    "Description": "负责数据集成、数据开发和服务开发",
                    "DisplayName": "数据工程师",
                    "MemberCount": null,
                    "OperateTime": null,
                    "Operator": null,
                    "Parameters": null,
                    "Privileges": null,
                    "ProjectId": null,
                    "RoleId": "308335260676890624",
                    "RoleName": "DataEngineer",
                    "RoleType": null,
                    "SystemDefault": null,
                    "UpdateTime": null,
                    "UpdateTimeStr": "1629985314533"
                },
                {
                    "CreateTime": null,
                    "CreateTimeStr": "1600938213690",
                    "Creator": null,
                    "Description": "运维中心，负责平台和业务运维工作，平台运维主要指在私有云环境",
                    "DisplayName": "运维工程师",
                    "MemberCount": null,
                    "OperateTime": null,
                    "Operator": null,
                    "Parameters": null,
                    "Privileges": null,
                    "ProjectId": null,
                    "RoleId": "308335260844662784",
                    "RoleName": "OperationEngineer",
                    "RoleType": null,
                    "SystemDefault": null,
                    "UpdateTime": null,
                    "UpdateTimeStr": "1629985314558"
                },
                {
                    "CreateTime": null,
                    "CreateTimeStr": "1600938213696",
                    "Creator": null,
                    "Description": "只读账号",
                    "DisplayName": "访客",
                    "MemberCount": null,
                    "OperateTime": null,
                    "Operator": null,
                    "Parameters": null,
                    "Privileges": null,
                    "ProjectId": null,
                    "RoleId": "308335260945326080",
                    "RoleName": "Visitor",
                    "RoleType": null,
                    "SystemDefault": null,
                    "UpdateTime": null,
                    "UpdateTimeStr": "1629985314587"
                }
            ],
            "TotalCount": 4,
            "TotalPageNumber": 0
        },
        "RequestId": "8de3d3ad-978c-426b-83bb-f1af8b534ff1"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
OperationDenied.UserNotInWhitelistError 用户不在白名单。
中国站
目录