All Products
Search
Document Center

Auto Scaling:AttachAlbServerGroups

Last Updated:Sep 10, 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 Virtual Private Cloud (VPC), and the scaling group must reside 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The ID of the region where the scaling group resides.

Examples: ap-southeast-1 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 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****

ForceAttach

boolean

No

Specifies whether to add the existing ECS instances or elastic container instances in the scaling group to the new ALB server group. Valid values:

  • true: The instances are added. The system returns a ScalingActivityId. You can use the scaling activity ID to check whether the existing instances are added.

  • false: The instances are not added.

Default value: false.

false

AlbServerGroup

array<object>

Yes

The list of ALB server groups.

object

No

The list of ALB server groups.

AlbServerGroupId

string

Yes

The ID of the ALB server group.

N specifies the 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 request a quota increase, go to 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 specifies the number of the ALB server group.

A higher weight indicates that the instance receives more requests. If the weight is 0, the instance does not receive any 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 specifies the number of the ALB server group. If the values of N are the same but the values of Port are different, the system associates the ALB server group with the scaling group multiple times, each with a different port.

22

Response elements

Element

Type

Description

Example

object

ScalingActivityId

string

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

Note

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

asa-2ze6wxj8vsohn6j9****

RequestId

string

The request ID.

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.