All Products
Search

This Product

    Auto Scaling:DetachServerGroups

    Document Center

    Auto Scaling:DetachServerGroups

    Last Updated:Jun 24, 2024

    Detach server groups from a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the DetachServerGroups operation. By detaching Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups from your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.

    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.

    		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 token, but you must 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 Ensure idempotence.

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

    Specifies whether to remove the existing Elastic Compute Service (ECS) instances or elastic container instances in the scaling group from the server group marked for detachment.

    • true
    • false

    Default value: false.

    		false
    ServerGroupsobject []Yes

    The information about the server groups.

    ServerGroupIdstringYes

    The ID of the server group.

    		sgp-1gv2uidn2msy****
    TypestringYes

    The type of the server group. Valid values:

    • ALB
    • NLB
    		ALB
    PortintegerYes

    The port used by ECS instances or elastic container instances as backend servers of the server group.

    		22

    Response parameters

    ParameterTypeDescriptionExample
    object
    ScalingActivityIdstring

    The ID of the scaling activity. During the scaling activity, the server group is detached from the scaling group and the existing servers, which are the 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****
    RequestIdstring

    The ID of the request.

    		6EF9BFEE-FE07-4627-B8FB-14326FB9****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-12-18The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.