If the current scaling group is in the enable state and no scaling activity is in the execute state in the scaling group, you can invoke the RemoveInstances API operation to delete one or more unneeded instances from a scaling group.
Operation description
Operation description
-
Before you invoke this operation, make sure that the following conditions are met:
-
The scaling group is in the enable (Active) state.
-
No scaling activity is in the execute state in the scaling group.
-
When no scaling activity is in the execute state in the scaling group, this operation bypasses the cooldown time (DefaultCooldown) and will directly execute.
-
If an ECS instance is created through automatic creation by Auto Scaling, or was manually added and managed by the scaling group, the ECS instance will trigger the economical mode or be released when you delete the ECS instance from the scaling group.
-
If an ECS instance was manually added and is not managed by the scaling group, the ECS instance is not stopped or released when you delete the ECS instance from the scaling group.
-
If the number of instances in the scaling group (TotalCapacity) minus the number of instances specified in this operation is less than the minimum number of instances (MinSize) in the scaling group, the invocation failed.
A successful response to the invocation of this operation only indicates that the Auto Scaling service accepted the invocation request of this operation and the scaling activity can execute. It does not mean that the scaling activity will execute successfully. You must check the execute status of the scaling activity by using the returned ScalingActivityId.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ess:DetachInstances |
update |
*ScalingGroup
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ScalingGroupId |
string |
Yes |
The ID of the scaling group. |
asg-bp18p2yfxow2dloq**** |
| RemovePolicy |
string |
No |
Specifies the action for the removed ECS instances. Valid values:
Default value: release. |
release |
| DecreaseDesiredCapacity |
boolean |
No |
Specifies whether to modify the expected number of instances. Valid values:
Default value: true. |
true |
| IgnoreInvalidInstance |
boolean |
No |
Specifies whether to ignore invalid instances when you delete a batch of instances from the scaling group. Valid values:
Default value: false. |
false |
| InstanceId |
array |
Yes |
The IDs of the ECS instances to be removed. |
i-28wt4**** |
|
string |
No |
The ID of the ECS instance to be removed. Valid values of N: 1 to 20. |
i-28wt4**** |
|
| RegionId |
string |
No |
The region ID of the scaling group. |
cn-qingdao |
| ClientToken |
string |
No |
Ensures the idempotence of the request. You can generate a parameter value from your client to ensure that the value is unique across different requests. The value can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. |
123e4567-e89b-12d3-a456-42665544**** |
| StopInstanceTimeout |
integer |
No |
The timeout period for waiting for the ECS instances to be stopped during the scale-in process. Unit: seconds. Valid values: 30 to 240. Note
|
60 |
| LifecycleHookContext |
object |
No |
The context information of the lifecycle hooks. |
|
| DisableLifecycleHook |
boolean |
No |
Specifies whether to disable all lifecycle hooks for the scaling activity. Valid values:
|
false |
| IgnoredLifecycleHookIds |
array |
No |
The IDs of the lifecycle hooks to be disabled for the scaling activity. |
|
|
string |
No |
The IDs of the lifecycle hooks to be disabled for the scaling activity. |
ash-bp14zolna43z266bq*** |
|
| LifecycleHookResult |
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| ScalingActivityId |
string |
The ID of the scaling activity. |
asa-bp175o6f6ego3r2j**** |
| RequestId |
string |
The ID of the request. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| IgnoredInstances |
object |
||
| IgnoredInstance |
array<object> |
||
|
object |
|||
| InstanceId |
string |
||
| Code |
string |
||
| Message |
string |
Examples
Success response
JSON format
{
"ScalingActivityId": "asa-bp175o6f6ego3r2j****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"IgnoredInstances": {
"IgnoredInstance": [
{
"InstanceId": "",
"Code": "",
"Message": ""
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.