获取角色详情

最近更新时间:2019-07-24 15:12:44

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetRole
Version String 公共参数,本接口取值:2019-01-16
Region String 公共参数,本接口不需要传递此参数。
RoleId String 角色 ID,用于指定角色,入参 RoleId 与 RoleName 二选一
RoleName String 角色名,用于指定角色,入参 RoleId 与 RoleName 二选一

3. 输出参数

参数名称 类型 描述
RoleInfo RoleInfo 角色详情
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取角色详情

输入示例

https://cam.tencentcloudapi.com/?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
    },
    "RequestId": "87fb9770-0fca-4c5a-b985-1c36b05a95cb"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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