DetachVServerGroups-Auto Scaling(ESS)-阿里云帮助中心

Removes one or more virtual server groups.

Operation description

To confirm the virtual server groups to remove, you must specify the following request parameters at the same time:
- LoadBalancerId: the instance ID of the load balancing instance.
- VServerGroupId: the ID of the virtual server group.
- Port: the port number of the virtual server group.
If the virtual server groups specified in the request parameters match those associated with the scaling group, the virtual server groups are removed. If no match is found, the removal request is ignored and no error is returned.
When you remove a load balancing instance from a scaling group, confirm that the load balancing instance no longer distributes requests to instances in the scaling group to prevent service request loss.

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:DetachVServerGroups

update

*ScalingGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the scaling group resides, such as `ap-southeast-1` or `cn-shanghai`. For more information, see Regions and zones.	cn-hangzhou
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 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****
ForceDetach	boolean	No	Specifies whether to remove the instances in the current scaling group from the virtual server groups to be removed. true: removes the instances. If you set this parameter to `true`, the system removes the instances that are associated with the scaling group from the backend servers of the load balancing instance when the load balancing instance is removed from the scaling group. false: does not remove the instances. If you set this parameter to `false`, the system does not remove the instances that are associated with the scaling group from the backend servers of the load balancing instance when the load balancing instance is removed from the scaling group. Default value: false.	false
VServerGroup	array<object>	Yes	The information about the virtual server groups associated with the scaling group.
	array<object>	No	The information about the virtual server groups to be removed.
VServerGroupAttribute	array<object>	No	The attribute column list of virtual server groups.
	object	No	The list of virtual server groups.
VServerGroupId	string	No	The ID of the virtual server group. The first N specifies the load balancing instance number. Valid values: 1 to 5. The second N specifies the virtual server group number under the load balancing instance. Valid values: 1 to 5.	rsp-bp1jp1rge****
Port	integer	No	The port number used by Auto Scaling to add ECS instances or elastic container instances to the virtual server group. Valid values: 1 to 65535. The first N specifies the load balancing instance number. Valid values: 1 to 5. The second N specifies the virtual server group number under the load balancing instance. Valid values: 1 to 5.	22
LoadBalancerId	string	No	The ID of the load balancing instance to which the virtual server group belongs. N specifies the load balancing instance number. Valid values: 1 to 5. Note You can remove up to five load balancing instances from a scaling group at a time.	lb-bp1p90y3ya9h8s62d****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.