有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(GetRole)用于获取指定角色的详细信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetRole。
Version String 公共参数,本接口取值:2019-01-16。
Region String 公共参数,此参数为可选参数。
RoleId String 角色 ID,用于指定角色,入参 RoleId 与 RoleName 二选一
示例值:4611686018427844696
RoleName String 角色名,用于指定角色,入参 RoleId 与 RoleName 二选一
示例值:QCSRole

3. 输出参数

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

4. 示例

示例1 获取角色详情

输入示例

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

{
    "RoleId": "4611686018427844696"
}

输出示例

{
    "Response": {
        "RoleInfo": {
            "RoleId": "4611686018427844696",
            "RoleName": "test_1234544",
            "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"cloudaudit.cloud.tencent.com\",\"cls.cloud.tencent.com\"]}}]}",
            "Description": "abc",
            "AddTime": "2019-07-10 11:22:27",
            "UpdateTime": "2019-07-10 11:22:27",
            "ConsoleLogin": 0,
            "RoleType": "system",
            "SessionDuration": 43200,
            "DeletionTaskId": "114",
            "Tags": [
                {
                    "Value": "xx",
                    "Key": "xx"
                }
            ]
        },
        "RequestId": "87fb9770-0fca-4c5a-b985-1c36b05a95cb"
    }
}

示例2 获取服务相关角色详情

输入示例

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

{
    "RoleId": "4611686018427411642"
}

输出示例

{
    "Response": {
        "RoleInfo": {
            "RoleId": "4611686018427411642",
            "RoleName": "byron3214_QcsRole",
            "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"ccslinked.qcloud.com\"]}}]}",
            "Description": "role222",
            "AddTime": "2020-03-25 11:03:00",
            "UpdateTime": "2020-03-25 11:03:00",
            "ConsoleLogin": 0,
            "RoleType": "service_linked",
            "SessionDuration": 43200,
            "DeletionTaskId": "114",
            "Tags": [
                {
                    "Value": "xx",
                    "Key": "xx"
                }
            ]
        },
        "RequestId": "1fb826eb-6d21-42f3-8f6e-9f51360f585d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.SystemError 内部错误。
InvalidParameter.ParamError 非法入参。
InvalidParameter.RoleNotExist 角色不存在。