列举用户角色信息

最近更新时间:2024-09-06 01:29:00

我的收藏

1. 接口描述

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

列举用户角色信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserRoles。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 列举的数量限制
Offset Integer 列举的偏移位置
Fuzzy String 按照arn模糊列举
SortBy String 返回结果按照该字段排序
示例值:modify-time
Sorting String 正序或者倒序,例如:desc

3. 输出参数

参数名称 类型 描述
Total Integer 符合列举条件的总数量
UserRoles Array of UserRole 用户角色信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 test

输入示例

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

{
    "Limit": 0,
    "Offset": 0,
    "Fuzzy": "abc",
    "SortBy": "abc",
    "Sorting": "abc"
}

输出示例

{
    "Response": {
        "Total": 0,
        "UserRoles": [
            {
                "RoleId": 0,
                "AppId": "abc",
                "Uin": "abc",
                "Arn": "abc",
                "ModifyTime": 0,
                "Desc": "abc",
                "RoleName": "abc",
                "Creator": "abc",
                "CosPermissionList": [
                    {
                        "CosPath": "abc",
                        "Permissions": [
                            "abc"
                        ]
                    }
                ],
                "PermissionJson": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

示例2 列举用户角色信息

输入示例

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

{
    "Fuzzy": "1",
    "Limit": 0,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Total": 1,
        "UserRoles": [
            {
                "RoleId": 0,
                "AppId": "1234",
                "Uin": "1234",
                "ModifyTime": 1650424290,
                "Arn": "11",
                "Desc": "test role"
            }
        ],
        "RequestId": "2ae4707a-9f72-44aa-9fd4-65cb739d6301"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。