DetachInstanceRamRole - Elastic Compute Service - Alibaba Cloud Documentation Center

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

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecs:DetachInstanceRamRole	update	All Resources *	none	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 provided by RAM to query the instance RAM roles that you created.	RamRoleTest
InstanceIds	string	Yes	The IDs of instances. The value can be a JSON array that consists of up to 100 instance IDs. Separate the IDs with commas (,).	["i-bp67acfmxazb4p**", "i-bp67acfmxazb5p", "i-bp67acfmxazb6p**"…]

Response parameters

Parameter	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 instances from which you attempted to detach instance RAM roles.	1
FailCount	integer	The number of instances from which instance RAM roles failed to be detached.	0
DetachInstanceRamRoleResults	array<object>	Details about the results of detaching instance RAM roles from the instances.
	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 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	array<object>	Details about the instance RAM role of the instance.
	object
RamRoleName	string	The name of the instance RAM role.	RamRoleTest
InstanceId	string	The instance ID.	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 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.	The specified instance does not exist.

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

Change history

Change time	Summary of changes	Operation

No change history