AttachLoadBalancers - Attach load balancers to scaling group - Auto Scaling

Attaches one or more load balancers to a scaling group to distribute traffic across instances in the group.

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

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 existing scaling group instances as backend servers of the load balancer. Valid values: true: Adds existing scaling group instances to the backend server groups of the attached load balancer. Note To add existing instances to the backend server groups of an already-attached load balancer, call this operation with ForceAttach set to `true`. false: Does not add existing instances to the backend server groups. Default value: false.	false
ClientToken	string	No	The client token used to ensure idempotence. The token must be unique across requests, contain only ASCII characters, and cannot exceed 64 characters in length. Ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
Async	boolean	No	Specifies whether to use asynchronous mode. In async mode, the call succeeds only when all operations succeed. If any operation fails, the entire call fails. Recommended: true. Valid values: true: Attaches the CLB instance asynchronously and returns the scaling activity ID. false: Attaches the CLB instance synchronously. Default value: false.	false
LoadBalancers	array	No	The IDs of the load balancers that you want to attach to the scaling group.
	string	No	The ID of the load balancer that you want to attach to the scaling group. Note You can attach up to five load balancers per call.	lb-2zeur05gfs****
LoadBalancerConfigs	array<object>	No	The CLB (formerly SLB) instance configurations.
	object	No
LoadBalancerId	string	No	The ID of the CLB instance.	147b46d767c-cn-qingdao-cm5****
Weight	integer	No	The weight of an ECS instance or elastic container instance as a backend server. Higher weight routes more traffic to the instance. Zero weight routes no traffic. Valid values: 0 to 100.	10

Response elements

Element	Type	Description	Example
	object
ScalingActivityId	string	The ID of the scaling activity. Returned only when `Async` is set to `true`. Call DescribeScalingActivities to query scaling activity IDs and status.	asa-bp140qd7mak8k63f****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.