All Products
Search
Document Center

Auto Scaling:DetachAlbServerGroups

Last Updated:Jun 06, 2024

Disassociates one or more Application Load Balancer (ALB) server groups from a scaling group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the scaling group. Examples: cn-hangzhou and cn-shanghai.

cn-hangzhou
ScalingGroupIdstringYes

The ID of the scaling group.

asg-bp18p2yfxow2dloq****
ClientTokenstringNo

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 the idempotence of a request.

123e4567-e89b-12d3-a456-42665544****
ForceDetachbooleanNo

Specifies whether to remove existing Elastic Compute Service (ECS) instances from the ALB server group that you want to disassociate from the scaling group. Valid values:

  • true: removes existing ECS instances and returns the value of the ScalingActivityId parameter. You can use the scaling activity ID to check whether the ECS instances are removed.
  • false: does not remove existing ECS instances.

Default value: false.

false
AlbServerGroupsobject []Yes

Details of the ALB server groups.

AlbServerGroupIdstringYes

The ID of the ALB server group.

sgp-ddwb0y0g6y9bjm****
PortintegerYes

The port number used by the ECS instances in the ALB server group.

22

Response parameters

ParameterTypeDescriptionExample
object
ScalingActivityIdstring

The ID of the scaling activity in which the ALB server group is disassociated from the scaling group and the ECS instances in the ALB server group are removed from the ALB server group. This parameter is returned only after you set the ForceDetach parameter to true.

asa-2ze6wxj8vsohn6j9****
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history