Use DetachServerGroups to remove server groups from a scaling group - Auto Scaling - Alibaba Cloud - Auto Scaling

Removes one or more server groups from a scaling group. Supported server group types: Application Load Balancer (ALB), Network Load Balancer (NLB), and Gateway Load Balancer (GWLB).

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

ess:DetachServerGroups

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group.	cn-hangzhou
ScalingGroupId	string	Yes	The ID of the scaling group.	asg-bp18p2yfxow2dloq****
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but you must ensure that the token is unique across requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
ForceDetach	boolean	No	Specifies whether to remove existing Elastic Compute Service (ECS) instances or elastic container instances in the scaling group from the server group being detached. true false Default value: false.	false
ServerGroups	array<object>	Yes	The server groups to detach.
	object	No	The server groups.
ServerGroupId	string	Yes	The ID of the server group.	sgp-1gv2uidn2msy****
Type	string	Yes	The type of the server group. Valid values: ALB NLB GWLB	ALB
Port	integer	No	The port used by ECS instances or elastic container instances as backend servers of the server group. Note Required for ALB and NLB types. For GWLB, this parameter cannot be set and defaults to 6081.	22

Response elements

Element	Type	Description	Example
	object
ScalingActivityId	string	The ID of the scaling activity in which the server group is detached and existing ECS instances or elastic container instances in the scaling group are removed from the server group. Note This parameter is returned only if you set `ForceDetach` to `true`.	asa-bp1gbswjhjrw8tko****
RequestId	string	The ID of the request.	6EF9BFEE-FE07-4627-B8FB-14326FB9****

Examples

Success response

JSON format

{
  "ScalingActivityId": "asa-bp1gbswjhjrw8tko****",
  "RequestId": "6EF9BFEE-FE07-4627-B8FB-14326FB9****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.