EnterStandby - Auto Scaling - Alibaba Cloud Documentation Center

Puts an Elastic Compute Service (ECS) instance into the Standby state.

Operation description

Description

If you call the operation to put an ECS instance in a scaling group that is associated with a Classic Load Balancer (CLB) instance into the Standby state, the weight of the ECS instance as a backend server of the CLB instance is set to 0.
You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
If Auto Scaling considers an ECS instance that is in the Standby state unhealthy, for example, the ECS instance is being stopped or being restarted, Auto Scaling does not update the health status of the ECS instance or trigger scale-in activities to remove the ECS instance from the scaling group. Auto Scaling updates the health status of the ECS instance only when the ECS instance is no longer in the Standby state.

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.

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
ess:EnterStandby	update	All Resources *	none	none

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 value, but you must ensure that the value 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****
InstanceIds	array	Yes	The IDs of the ECS instances.
	string	Yes	The IDs of the ECS instances.	i-28wt4****
Async	boolean	No	Specifies whether to asynchronously put the ECS instance into the Standby state. Valid values: true false Default value: false.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ScalingActivityId	string	The ID of the scaling activity.	asa-2zeb04oym05qaceq****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScalingActivityId": "asa-2zeb04oym05qaceq****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history

HTTP status code	Error code	Error message	Description
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.	The error message returned because the RAM user is not authorized to call this operation. Contact the Alibaba Cloud account for the authorization and try again.
404	InvalidInstanceId.NotFound	Instance “XXX” does not exist.	The error message returned because the specified ECS instance does not exist.
404	InvalidScalingGroupId.NotFound	The specified scaling group does not exist.	The error message returned because the specified scaling group does not exist.