All Products
Search
Document Center

Auto Scaling:AttachLoadBalancers

Last Updated:Oct 26, 2026

Adds one or more load balancing instances.

Operation description

Operation description

You must meet the following conditions when you add load balancing instances to a scaling group:

  • The load balancing instances and the scaling group must belong to the same Alibaba Cloud account and region.

  • The load balancing instances must be in the Running state.

  • Each load balancing instance must be configured with at least one listener and have health checks enabled.

  • If the network type of both the load balancing instances and the scaling group is VPC, they must be in the same VPC.

  • If the network type of the scaling group is VPC and the network type of the load balancing instances is classic network, and the backend servers of the load balancing instances include VPC-connected instances, these VPC-connected instances must be in the same VPC as the scaling group.

  • The number of load balancing instances associated with the scaling group does not exceed the quota limit. For more information about the quota limit, see Limits.

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

update

*ScalingGroup

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

None None

Request parameters

Parameter

Type

Required

Description

Example

ScalingGroupId

string

Yes

The ID of the scaling group.

asg-bp1avr6ensitts3w****

ForceAttach

boolean

No

Specifies whether to add all instances in the current scaling group as backend servers of the load balancing CLB (formerly SLB) instances. Valid values:

  • true: adds the instances. If this parameter is set to true, when you add the load balancing instances to the scaling group, the system adds all existing instances in the scaling group as backend servers of the load balancing instances.

    Note

    If a load balancing instance is already added to the scaling group and you want to add all instances in the scaling group as backend servers of the load balancing instance, you can add the load balancing instance to the scaling group again and set ForceAttach to true.

  • false: does not add the instances. If this parameter is set to false, when you add the load balancing instances to the scaling group, the system does not add the existing instances in the scaling group as backend servers of the load balancing instances.

Default value: false.

false

ClientToken

string

No

Ensures the idempotence of the request.

You can generate the parameter value on your client to ensure that the value is unique across different requests. The value 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****

Async

boolean

No

Specifies whether to use asynchronous invocation when you add load balancing CLB (formerly SLB) instances. Asynchronous invocation ensures the transactionality of operations. This means that either all operations are executed successfully, or if any operation fails, the execution results of all operations do not take effect. We recommend that you use asynchronous invocation.

Valid values:

  • true: asynchronous invocation. The request returns the ID of the scaling activity.

  • false: synchronization call.

Default value: false.

false

LoadBalancer

array

No

The IDs of the load balancing CLB (formerly SLB) instances to be added. Valid values of N: 1 to 5.

lb-2zeur05gfs****

string

No

The IDs of the load balancing CLB (formerly SLB) instances to be added. Valid values of N: 1 to 5.

Note

You can add up to five load balancing instances to the scaling group at a time.

lb-2zeur05gfs****

LoadBalancerConfig

array<object>

No

The configurations of the load balancing CLB (formerly SLB) instances.

object

No

The configurations of the load balancing CLB (formerly SLB) instances.

LoadBalancerId

string

No

The ID of the load balancing CLB (formerly SLB) instance.

147b46d767c-cn-qingdao-cm5****

Weight

integer

No

The weight of the ECS instance or ECI instance as a backend server after Auto Scaling adds the ECS instance or ECI instance to the CLB server group. A higher weight indicates that the ECS instance or ECI instance is assigned more access requests. If the weight is 0, the ECS instance or ECI instance does not receive access requests.

Valid values: 0 to 100.

10

Response elements

Element

Type

Description

Example

object

ScalingActivityId

string

The ID of the scaling activity.

This parameter is returned only when Async is set to true. You can call the DescribeScalingActivities operation to query the returned scaling activity ID and check the execution status of the scaling activity.

asa-bp140qd7mak8k63f****

RequestId

string

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "ScalingActivityId": "asa-bp140qd7mak8k63f****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.