Updates the information of a Resource Access Management (RAM) role.
Operation description
In this example, the description of the RAM role ECSAdmin is updated to ECS administrator.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ram:UpdateRole | Write |
|
| none |
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 |
| NewAssumeRolePolicyDocument | string | No | 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" } |
| NewMaxSessionDuration | long | No | The maximum session duration of the RAM role. Unit: seconds. Valid values: 3600 to 43200. Default value: 3600. If you do not specify this parameter, the default value is used. | 3600 |
| NewDescription | string | No | The description of the RAM role. The description must be 1 to 1,024 characters in length. | ECS administrator |
For more information about common request parameters, see Common parameters.
Response parameters
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",
"Description": "ECS administrator",
"UpdateDate": "2016-01-23T12:33:18Z",
"MaxSessionDuration": 3600,
"RoleName": "ECSAdmin",
"CreateDate": "2015-01-23T12:33:18Z",
"RoleId": "90123456789****",
"Arn": "acs:ram::123456789012****:role/ECSAdmin"
}
}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. |
| 400 | InvalidParameter.NewAssumeRolePolicyDocument.Length | The maximum length of the new trust policy document of the role is exceeded. | The maximum length of the new trust policy document of the role is exceeded. |
| 404 | EntityNotExist.Role | The role does not exist. | The role does not exist. |
| 409 | MalformedPolicyDocument | The policy format is invalid. | The policy format is invalid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|