All Products
Search
Document Center

Elastic Compute Service:AttachInstanceRamRole

Last Updated:Dec 06, 2024

Attaches an instance Resource Access Management (RAM) role to Elastic Compute Service (ECS) instances.

Operation description

You can call the DescribeInstanceRamRole operation to query the instance RAM roles that are attached to ECS instances.

Note If an ECS instance already has an instance RAM role, an error is returned when you attach another instance RAM role to the instance.

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.

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
ecs:AttachInstanceRamRoleupdate
*All Resources
*
    none
  • ram:PassRole

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
RamRoleNamestringYes

The name of the instance RAM role. You can call the ListRoles operation provided by RAM to query the instance RAM roles that you created.

testRamRoleName
InstanceIdsstringYes

The IDs of the instances. The value can be a JSON array that consists of up to 100 instance IDs. Separate the IDs with commas (,).

[“i-bp14ss25xca5ex1u****”, “i-bp154z5o1qjalfse****”, “i-bp10ws62o04ubhvi****”…]
PolicystringNo

The policy. The policy document must be 1 to 1,024 characters in length. When you attach an instance RAM role to one or more instances, you can specify an additional policy to further limit the permissions of the role. For more information, see Policy overview.

{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}

Response parameters

ParameterTypeDescriptionExample
object
RamRoleNamestring

The name of the instance RAM role.

testRamRoleName
RequestIdstring

The request ID.

D9553E4C-6C3A-4D66-AE79-9835AF705639
TotalCountinteger

The total number of instances to which you attempted to attach the instance RAM role.

1
FailCountinteger

The number of instances to which the instance RAM role failed to be attached.

0
AttachInstanceRamRoleResultsarray<object>

Details about the results of attaching the instance RAM role.

AttachInstanceRamRoleResultobject
Codestring

Indicates whether the instance RAM role was attached. If the instance RAM role was attached, 200 is returned. If the instance RAM role failed to be attached, any other value is returned. For more information, see the "Error codes" section.

200
Messagestring

Indicates whether the instance RAM role was attached. If the instance RAM role was attached, success is returned. If the instance RAM role failed to be attached, any other value is returned. For more information, see the "Error codes" section.

success
InstanceIdstring

The ID of the instance.

i-bp10ws62o04ubhvi****
Successboolean

Indicates whether the instance RAM role was attached.

true

Examples

Sample success responses

JSONformat

{
  "RamRoleName": "testRamRoleName",
  "RequestId": "D9553E4C-6C3A-4D66-AE79-9835AF705639",
  "TotalCount": 1,
  "FailCount": 0,
  "AttachInstanceRamRoleResults": {
    "AttachInstanceRamRoleResult": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp10ws62o04ubhvi****",
        "Success": true
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidInstanceIds.MalformedThe specified instanceIds are not valid.Multiple specified instance IDs are invalid.
403InvalidNetworkType.MismatchRamRoleRam role cannot be applied to instances of Classic network type.Instance RAM roles can be used only for instances of the VPC type, not for instances of the classic network type.
403InvalidUser.PassRoleForbiddenThe RAM user does not have the privilege to pass a RAM role.The RAM user is not authorized to pass a RAM role.
404InvalidInstanceId.NotFoundThe specified instanceId does not exist.The specified instance does not exist.
404InvalidRamRole.NotFoundThe specified RAMRoleName does not exist.The specified RamRoleName parameter does not exist.
404InvalidRamRole.NotEcsRoleThe specified ram role is not authorized for ecs, please check your role policy.The specified RAM role is not authorized to use ECS. Check your role policies.

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

Change history

Change timeSummary of changesOperation
2023-07-10The Error code has changedView Change Details