Sets ECS instances in a scaling group to the standby state.
Operation description
Operation description
-
If the scaling group is associated with a load balancing instance, the weight of the corresponding instance in the load balancing instance is set to 0.
-
When an instance is in the standby state, you can manually remove and release the instance from the scaling group as Normal.
-
For scaling activities triggered by changes in the number of instances in the scaling group or by monitoring nodes for automatic scale-in, instances in the standby state are not removed.
-
When an instance is in the standby state, if the instance enters an unhealthy state (for example, stopping or restarting), the health check status of the instance is not updated, and no scaling activity is triggered to remove the unhealthy instance. The health check status is updated only after the instance exits the standby state.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ScalingGroupId |
string |
Yes |
The ID of the scaling group. |
asg-bp1fo0dbtsbmqa9h**** |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. |
123e4567-e89b-12d3-a456-42665544**** |
| InstanceId |
array |
Yes |
The ID of the ECS instance or elastic container instance. |
i-28wt4**** |
|
string |
No |
The ID of the ECS instance or elastic container instance. |
i-28wt4**** |
|
| Async |
boolean |
No |
Specifies whether to use an asynchronous task. Valid values:
Default value: false. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| ScalingActivityId |
string |
The ID of the scaling activity. |
asa-2zeb04oym05qaceq**** |
Examples
Success response
JSON format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ScalingActivityId": "asa-2zeb04oym05qaceq****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.