All Products
Search
Document Center

Elastic Compute Service:DetachInstanceRamRole

Last Updated:Nov 14, 2024

Detaches instance Resource Access Management (RAM) roles from Elastic Compute Service (ECS) instances.

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:DetachInstanceRamRoleupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
RamRoleNamestringNo

The name of the instance RAM role. You can call the ListRoles operation of RAM to query the names of available instance RAM roles.

RamRoleTest
InstanceIdsstringYes

The IDs of ECS instances. You can specify 1 to 100 instance IDs.

["i-bp67acfmxazb4p****", "i-bp67acfmxazb5p****", "i-bp67acfmxazb6p****"…]

Response parameters

ParameterTypeDescriptionExample
object
RamRoleNamestring

The name of the instance RAM role.

RamRoleTest
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

The total number of ECS instances from which you attempted to detach instance RAM roles.

1
FailCountinteger

The number of ECS instances from which instance RAM roles failed to be detached.

0
DetachInstanceRamRoleResultsarray<object>

The results of the instance RAM role detachment, which include the names of the instance RAM roles and the IDs of the ECS instances from which you attempted to detach the instance RAM roles.

DetachInstanceRamRoleResultobject
Codestring

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

200
Messagestring

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

Success
InstanceIdstring

The ID of the ECS instance from which you attempted to detach the instance RAM role.

i-bp67acfmxazb4p****
Successboolean

Indicates whether the instance RAM role was detached.

true
InstanceRamRoleSetsarray<object>

The name of the instance RAM role and the ID of the ECS instance.

InstanceRamRoleSetobject
RamRoleNamestring

The name of the instance RAM role.

RamRoleTest
InstanceIdstring

The ID of the ECS instance.

i-bp67acfmxazb4p****

Examples

Sample success responses

JSONformat

{
  "RamRoleName": "RamRoleTest",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "FailCount": 0,
  "DetachInstanceRamRoleResults": {
    "DetachInstanceRamRoleResult": [
      {
        "Code": "200",
        "Message": "Success",
        "InstanceId": "i-bp67acfmxazb4p****",
        "Success": true,
        "InstanceRamRoleSets": {
          "InstanceRamRoleSet": [
            {
              "RamRoleName": "RamRoleTest",
              "InstanceId": "i-bp67acfmxazb4p****"
            }
          ]
        }
      }
    ]
  }
}

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.

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

Change history

Change timeSummary of changesOperation
No change history