Query RAM role information by using GetRole - Resource Access Management - Alibaba Cloud - Resource Access Management

Retrieves the information about a role.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:GetRole

get

*Role

acs:ram:*:{#accountId}:role/{#RoleName}

None

Request parameters

Parameter	Type	Required	Description	Example
RoleName	string	No	The name of the role. The name must be 1 to 64 characters in length and can contain letters, digits, periods (.), and hyphens (-).	ECSAdmin

Response elements

Element	Type	Description	Example
	object
Role	object	The role information.
AssumeRolePolicyDocument	string	The access policy that specifies the permission to assume the role.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
UpdateDate	string	The time when the role was last updated. The time is in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.	2015-01-23T12:33:18Z
Description	string	The description of the role.	ECS management role
MaxSessionDuration	integer	The maximum session duration of the role.	3600
RoleName	string	The name of the role.	ECSAdmin
CreateDate	string	The time when the role was created. The time is in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.	2015-01-23T12:33:18Z
RoleId	string	The ID of the role.	901234567890****
Arn	string	The resource descriptor of the role.	acs:ram::123456789012****:role/ECSAdmin
AllowConsoleLogin	boolean	Indicates whether console logon is allowed for the RAM role.	true
IsServiceLinkedRole	boolean	Indicates whether the role is a service-linked role.	true
RolePrincipalName	string	The name of the role with the domain name suffix.	ECSAdmin@role.123456.onaliyunservice.com
LatestDeletionTask	object	The information about the most recent deletion task.
CreateDate	string	The time when the deletion task was created. The time is in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.	2018-10-23T12:33:18Z
DeletionTaskId	string	The ID of the deletion task.	task/acs-service-role/sas.aliyuncs.com/AliyunServiceRoleForSas/20843430-bb43-44fe-a7ff-02ab09183436
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "Role": {
    "AssumeRolePolicyDocument": "{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::123456789012****:root\" } } ], \"Version\": \"1\" }",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "ECS management role.",
    "MaxSessionDuration": 3600,
    "RoleName": "ECSAdmin",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "901234567890****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin",
    "AllowConsoleLogin": true,
    "IsServiceLinkedRole": true,
    "RolePrincipalName": "ECSAdmin@role.123456.onaliyunservice.com",
    "LatestDeletionTask": {
      "CreateDate": "2018-10-23T12:33:18Z",
      "DeletionTaskId": "task/acs-service-role/sas.aliyuncs.com/AliyunServiceRoleForSas/20843430-bb43-44fe-a7ff-02ab09183436"
    }
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.