GetRole - Resource Management - Alibaba Cloud Documentation Center

Queries the information of a RAM role.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RoleName	string	Yes	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
Language	string	No	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
Role	object	The information of the RAM role.
AssumeRolePolicyDocument	string	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\" }
RolePrincipalName	string	The name of the RAM role after authorization.	ECSAdmin@role.123456.onaliyunservice.com
UpdateDate	string	The time when the RAM role was updated.	2016-01-23T12:33:18Z
Description	string	The description of the RAM role.	ECS administrator
MaxSessionDuration	long	The maximum session duration of the RAM role.	3600
RoleName	string	The name of the RAM role.	ECSAdmin
CreateDate	string	The time when the RAM role was created.	2015-01-23T12:33:18Z
RoleId	string	The ID of the RAM role.	90123456789****
Arn	string	The Alibaba Cloud Resource Name (ARN) of the RAM role.	acs:ram::123456789012****:role/ECSAdmin
IsServiceLinkedRole	boolean	Indicates whether the RAM role is a service linked role.	true
LatestDeletionTask	object	The information of the most recent deletion task.
DeletionTaskId	string	The ID of the deletion task.	ECSAdmin/cc61514b-26eb-4453-ab53-b142eb702a3d
CreateDate	string	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 code	Error code	Error message	Description
400	InvalidParameter.RoleName.InvalidChars	The specified role name contains invalid characters.	The specified role name contains invalid characters.
400	InvalidParameter.RoleName.Length	The maximum length of the role name is exceeded.	The maximum length of the role name is exceeded.
404	EntityNotExist.Role	The role does not exist.	The role does not exist.

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

Change history

Change time	Summary of changes	Operation

No change history