文档中心>腾讯云 BI>API 文档>角色相关接口>行列权限项目内角色列表1

行列权限项目内角色列表1

最近更新时间:2025-09-02 01:12:44

我的收藏

1. 接口描述

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

行列权限项目内角色列表接口1

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePermissionRoleInfo。
Version String 公共参数,本接口取值:2022-01-05。
Region String 公共参数,此参数为可选参数。
ProjectId Integer 项目ID
示例值:1
PageNo Integer 页数
示例值:1
PageSize Integer 条数
示例值:1
AllPage Boolean 所有页码
示例值:1

3. 输出参数

参数名称 类型 描述
ErrorInfo ErrorInfo 自定义错误信息对象
注意:此字段可能返回 null,表示取不到有效值。
Data Array of Role 数据
注意:此字段可能返回 null,表示取不到有效值。
Msg String 消息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Extra String 112
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 项目内角色列表接口示例

项目内角色列表接口示例

输入示例

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

{
    "ProjectId": "1",
    "PageNo": "0",
    "PageSize": "10",
    "AllPage": "true"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Id": 1,
                "RoleName": "abc",
                "CorpId": "abc",
                "RoleType": "abc",
                "Scope": "abc",
                "Description": "abc",
                "CreatedAt": "abc",
                "CreatedUser": "abc",
                "UpdatedAt": "abc",
                "UpdatedUser": "abc",
                "ScopeType": 0,
                "CanChoose": true,
                "ModuleCollection": "abc"
            }
        ],
        "Msg": "abc",
        "Extra": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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