All Products
Search
Document Center

Resource Management:GetRole

Last Updated:Jun 05, 2024

Queries the information of a RAM role.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ram:GetRoleRead
  • Role
    acs:ram:*:{#accountId}:role/{#RoleName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RoleNamestringYes

The name of the RAM role.

The name must be 1 to 64 characters in length and can contain letters, digits, periods (.), and hyphens (-).

ECSAdmin
LanguagestringNo

The language that is used to return the description of the RAM role. Valid values:

  • en: English
  • zh-CN: Chinese
  • ja: Japanese
zh-CN

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368
Roleobject

The information of the RAM role.

AssumeRolePolicyDocumentstring

The document of the policy that specifies the trusted entity to assume the RAM role.

{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::12345678901234****:root\" } } ], \"Version\": \"1\" }
RolePrincipalNamestring

The name of the RAM role after authorization.

ECSAdmin@role.123456.onaliyunservice.com
UpdateDatestring

The time when the RAM role was updated.

2016-01-23T12:33:18Z
Descriptionstring

The description of the RAM role.

ECS administrator
MaxSessionDurationlong

The maximum session duration of the RAM role.

3600
RoleNamestring

The name of the RAM role.

ECSAdmin
CreateDatestring

The time when the RAM role was created.

2015-01-23T12:33:18Z
RoleIdstring

The ID of the RAM role.

90123456789****
Arnstring

The Alibaba Cloud Resource Name (ARN) of the RAM role.

acs:ram::123456789012****:role/ECSAdmin
IsServiceLinkedRoleboolean

Indicates whether the RAM role is a service linked role.

true
LatestDeletionTaskobject

The information of the most recent deletion task.

DeletionTaskIdstring

The ID of the deletion task.

ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d
CreateDatestring

The time when the deletion task was created.

2018-10-23T12:33:18Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "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 administrator",
    "MaxSessionDuration": 3600,
    "RoleName": "ECSAdmin",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "90123456789****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin",
    "IsServiceLinkedRole": true,
    "LatestDeletionTask": {
      "DeletionTaskId": "ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d",
      "CreateDate": "2018-10-23T12:33:18Z"
    }
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.RoleName.InvalidCharsThe specified role name contains invalid characters.The specified role name contains invalid characters.
400InvalidParameter.RoleName.LengthThe maximum length of the role name is exceeded.The maximum length of the role name is exceeded.
404EntityNotExist.RoleThe role does not exist.The role does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history