GetRole - 获取角色信息_资源管理(Resource Management)-阿里云帮助中心

调用GetRole获取角色信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ram:GetRole	Read	Role acs:ram:*:{#accountId}:role/{#RoleName}	无	无

请求参数

名称	类型	必填	描述	示例值
RoleName	string	是	角色名称。长度为 1~64 个字符，可包含英文字母、数字、点号（.）和短横线（-）。	ECSAdmin
Language	string	否	语言类型。角色描述将以此语言返回。 en：英文。 zh-CN：中文。 ja：日文。	zh-CN

返回参数

名称	类型	描述	示例值
	object
Role	object	角色信息。
AssumeRolePolicyDocument	string	扮演角色的权限策略内容。	{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::12345678901234****:root\" } } ], \"Version\": \"1\" }
RolePrincipalName	string	被授权角色名称。	ECSAdmin@role.123456.onaliyunservice.com
UpdateDate	string	角色更新时间。	2016-01-23T12:33:18Z
Description	string	角色描述。	ECS管理角色
MaxSessionDuration	long	角色最大会话时间。	3600
LatestDeletionTask	object	最近一次删除任务信息。
DeletionTaskId	string	删除任务 ID。	ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d
CreateDate	string	删除任务创建时间。	2018-10-23T12:33:18Z
RoleName	string	角色名称。	ECSAdmin
CreateDate	string	角色创建时间。	2015-01-23T12:33:18Z
RoleId	string	角色 ID。	90123456789****
Arn	string	角色的资源描述符。	acs:ram::123456789012****:role/ECSAdmin
IsServiceLinkedRole	boolean	是否为服务关联角色。	true
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368

示例

正常返回示例

JSON格式

{
  "Role": {
    "AssumeRolePolicyDocument": "{ \\\"Statement\\\": [ { \\\"Action\\\": \\\"sts:AssumeRole\\\", \\\"Effect\\\": \\\"Allow\\\", \\\"Principal\\\": { \\\"RAM\\\": \\\"acs:ram::12345678901234****:root\\\" } } ], \\\"Version\\\": \\\"1\\\" }",
    "RolePrincipalName": "ECSAdmin@role.123456.onaliyunservice.com",
    "UpdateDate": "2016-01-23T12:33:18Z",
    "Description": "ECS管理角色",
    "MaxSessionDuration": 3600,
    "LatestDeletionTask": {
      "DeletionTaskId": "ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d",
      "CreateDate": "2018-10-23T12:33:18Z"
    },
    "RoleName": "ECSAdmin",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "90123456789****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin",
    "IsServiceLinkedRole": true
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.RoleName.InvalidChars	The specified role name contains invalid characters.	角色名称包含无效字符。
400	InvalidParameter.RoleName.Length	The maximum length of the role name is exceeded.	角色名称长度超出限制。
404	EntityNotExist.Role	The role does not exist.	角色不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史