All Products
Search
Document Center

Auto Scaling:DetachAlbServerGroups

Last Updated:Oct 21, 2024

Detaches Application Load Balancer (ALB) server groups from a scaling group. When you call the DetachAlbServerGroups operation, you can specify the scaling group ID, ALB server group ID, and port used by Elastic Compute Service (ECS) instances in the desired ALB server group to detach one or more ALB server groups from your scaling group.

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.

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 the existing ECS instances from the ALB server group. Valid values:

  • true: removes the existing ECS instances from the ALB server group and returns the value of ScalingActivityId. You can query the value of ScalingActivityId to check whether the existing ECS instances are removed from the ALB server group.
  • false: does not remove the existing ECS instances from the ALB server group.

Default value: false.

false
AlbServerGroupsarray<object>Yes

Details of the ALB server groups.

objectYes

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 during which the ALB server group is detached from the scaling group and the existing ECS instances are removed from the ALB server group. This parameter has a return value only if you set ForceDetach 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