All Products
Search
Document Center

Auto Scaling:AttachServerGroups

Last Updated:Jun 06, 2024

Attaches server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachServerGroups operation. By attaching Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the scaling group.

cn-hangzhou
ScalingGroupIdstringYes

The ID of the scaling group.

asg-bp1fo0dbtsbmqa9h****
ClientTokenstringNo

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 Ensure idempotence.

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

Specifies whether to add the existing Elastic Compute Service (ECS) instances or elastic container instances in the scaling group to the server group. Valid values:

  • true
  • false

Default value: false.

false
ServerGroupsobject []Yes

The information about the server groups.

ServerGroupIdstringYes

The ID of the server group.

sgp-5yc3bd9lfyh*****
TypestringYes

The type of the server group. Valid values:

  • ALB
  • NLB
ALB
WeightintegerYes

The weight of an ECS instance or elastic container instance as a backend server of the server group. Valid values: 0 to 100.

If you assign a higher weight to an instance, the instance is allocated a larger proportion of access requests. If you assign zero weight to an instance, the instance is allocated no access requests.

100
PortintegerYes

The port used by ECS instances or elastic container instances after being added as backend servers to the server group.

Valid values: 1 to 65535.

22

Response parameters

ParameterTypeDescriptionExample
object
ScalingActivityIdstring

The ID of the scaling activity. During the scaling activity, the server group is attached to the scaling group and the existing ECS instances or elastic container instances in the scaling group are added to the server group.

Note This parameter is returned only if you set ForceAttach to true.
asa-bp1c9djwrgxjyk31****
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-18The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.