All Products
Search

This Product

    Auto Scaling:DetachServerGroups

    Document Center

    Auto Scaling:DetachServerGroups

    Last Updated:Sep 10, 2026

    Removes one or more load balancing server groups from a scaling group. Supported server group types include Application Load Balancer (ALB) and Network Load Balancer (NLB).

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the scaling group.

    cn-hangzhou
    ScalingGroupId

    string

    Yes

    The scaling group ID.

    asg-bp18p2yfxow2dloq****
    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 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 How to ensure idempotence.

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

    boolean

    No

    Specifies whether to remove ECS instances or elastic container instances in the current scaling group from the server groups to be removed. Valid values:

    • true: Removes the instances.

    • false: Does not remove the instances.

    Default value: false.

    false
    ServerGroup

    array<object>

    Yes

    The information about the load balancing server groups.

    object

    No

    The information about the load balancing server groups.

    ServerGroupId

    string

    Yes

    The ID of the load balancing server group.

    sgp-1gv2uidn2msy****
    Type

    string

    Yes

    The type of the load balancing server group. Valid values:

    • ALB: Application Load Balancer (ALB).

    • NLB: Network Load Balancer (NLB).

    • GWLB: Gateway Load Balancer (GWLB).

    ALB
    Port

    integer

    No

    The port number used by ECS instances or elastic container instances in the load balancing server group.

    Note

    This parameter is required for ALB and NLB load balancing server groups. This parameter cannot be configured for GWLB load balancing server groups. Settings default value is 6081.

    22

    Response elements

    Element

    Type

    Description

    Example

    object

    ScalingActivityId

    string

    The ID of the scaling activity that is triggered when ECS instances or elastic container instances are removed from the load balancing server group along with the server group removal.

    Note

    This parameter is returned only when ForceDetach is set to true.

    asa-bp1gbswjhjrw8tko****
    RequestId

    string

    The request ID.

    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.