All Products
Search
Document Center

Elastic Compute Service:AttachInstanceRamRole

Last Updated:May 16, 2024

Attaches an instance Resource Access Management (RAM) role to one or more Elastic Compute Service (ECS) instances. An instance can have only a single instance RAM role. If an instance already has an instance RAM role, an error is returned when you attach another instance RAM role to the instance.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

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
AttachInstanceRamRoleResultsobject []

Details about the results of attaching the instance RAM role.

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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 403