All Products
Search
Document Center

Auto Scaling:AttachAlbServerGroups

Last Updated:Oct 26, 2026

Adds one or more Application Load Balancer (ALB) server groups to a scaling group.

Operation description

Operation description

To add ALB server groups to a scaling group, the following conditions must be met:

  • The network type of the scaling group must be VPC, and the scaling group must be in the same VPC as the ALB server groups.

  • The ALB server groups must be in the available state.

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

update

*ScalingGroup

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

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The ID of the region to which the scaling group belongs.

Examples: cn-hangzhou and cn-shanghai. For more information, see Regions and zones.

cn-hangzhou

ScalingGroupId

string

Yes

The ID of the scaling group.

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 value, but you must make sure 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 idempotence.

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

ForceAttach

boolean

No

Specifies whether to add the ECS instances or elastic container instances in the scaling group to the newly added ALB server groups. Valid values:

  • true: adds the instances and returns ScalingActivityId. You can check whether the existing instances are added by viewing the scaling activity ID.

  • false: does not add the instances.

Default value: false.

false

AlbServerGroup

array<object>

Yes

The ALB server groups.

object

No

The ALB server groups.

AlbServerGroupId

string

Yes

The ID of the ALB server group.

N indicates the serial number of the ALB server group. The number of ALB server groups that can be associated with a scaling group is limited. To view or manually apply for a quota increase, go to the Quota Center.

sgp-ddwb0y0g6y9bjm****

Weight

integer

Yes

The weight of the ECS instance or elastic container instance as a backend server after Auto Scaling adds the instance to the ALB server group. N indicates the serial number of the ALB server group.

A higher weight specifies that more requests are distributed to the ECS instance or elastic container instance. If the weight is 0, the instance does not receive requests. Valid values: 0 to 100.

100

Port

integer

Yes

The port number used by the ECS instance or elastic container instance after Auto Scaling adds the instance to the ALB server group. Valid values: 1 to 65535.

Note

N indicates the serial number of the ALB server group. If N is the same but the port numbers are different, the system associates multiple ALB server groups with different port numbers to the scaling group by default.

22

Response elements

Element

Type

Description

Example

object

ScalingActivityId

string

The ID of the scaling activity that is triggered when ALB server groups are added and the ECS instances or elastic container instances in the scaling group are added to the ALB server groups.

Note

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

asa-2ze6wxj8vsohn6j9****

RequestId

string

The ID of the request.

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.