Call DetachInstanceRamRole to detach an instance RAM role from an ECS instance - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DetachInstanceRamRole

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

*Role

acs:ram:{#regionId}:{#accountId}:role/{#roleName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RamRoleName	string	No	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
InstanceIds	string	Yes	The IDs of ECS instances. You can specify 1 to 100 instance IDs.	["i-bp67acfmxazb4p**", "i-bp67acfmxazb5p", "i-bp67acfmxazb6p**"…]

Response elements

Element	Type	Description	Example
	object
RamRoleName	string	The name of the instance RAM role.	RamRoleTest
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of ECS instances from which you attempted to detach instance RAM roles.	1
FailCount	integer	The number of ECS instances from which instance RAM roles failed to be detached.	0
DetachInstanceRamRoleResults	object
DetachInstanceRamRoleResult	array<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.
	array<object>
Code	string	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
Message	string	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
InstanceId	string	The ID of the ECS instance from which you attempted to detach the instance RAM role.	i-bp67acfmxazb4p****
Success	boolean	Indicates whether the instance RAM role was detached.	true
InstanceRamRoleSets	object
InstanceRamRoleSet	array<object>	The name of the instance RAM role and the ID of the ECS instance.
	object
RamRoleName	string	The name of the instance RAM role.	RamRoleTest
InstanceId	string	The ID of the ECS instance.	i-bp67acfmxazb4p****

Examples

Success response

JSON format

{
  "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 response

JSON format

{
    "RequestId": "E6352369-5C2B-41CD-AB50-471550C8F674",
    "DetachInstanceRamRoleResults": {
        "DetachInstanceRamRoleResult": [
            {
                "Message": "success",
                "InstanceId": "i-instance1",
                "Code": "200"
            }
        ]
    },
    "TotalCount": 1,
    "FailCount": 0,
    "RamRoleName": "RamRoleTest"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceIds.Malformed	The specified instanceIds are not valid.	Multiple specified instance IDs are invalid.
403	InvalidNetworkType.MismatchRamRole	Ram 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.
403	InvalidUser.PassRoleForbidden	The RAM user does not have the privilege to pass a RAM role.	The RAM user is not authorized to pass a RAM role.
404	InvalidInstanceId.NotFound	The specified instanceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.