AttachServerGroups - Auto Scaling - Alibaba Cloud Documentation Center

Adds one or more load balancing server groups to a scaling group. Supported server group types include Application Load Balancer (ALB) and Network Load Balancer (NLB).

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

update

*ScalingGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group.	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 Instance (ECI) instances in the scaling group to the new server group. Valid values: true: Adds the instances. false: Does not add the instances. Default value: false.	false
ServerGroup	array<object>	Yes	The information about the load balancing server groups.
	object	No	The information about the load balancing server groups.
ServerGroupId	string	Yes	The ID of the load balancing server group.	sgp-60ofsqhwer0b***
Type	string	Yes	The type of the load balancing server group. Valid values: ALB: Application Load Balancer (ALB). NLB: Network Load Balancer (NLB). GWLB: Gateway Load Balancer (GWLB).	ALB
Weight	integer	No	The weight of an ECS instance or ECI instance as a backend server after Auto Scaling adds the instance to the server group. Valid values: 0 to 100. A higher weight indicates that the instance is allocated more access requests. If the weight is 0, the instance does not receive any access requests. Note This parameter is required for ALB and NLB load balancing server groups. You cannot configure this parameter in Settings for GWLB load balancing server groups.	100
Port	integer	No	The port number used by an ECS instance or ECI instance after Auto Scaling adds the instance to the server group. Valid values: 1 to 65535. Note This parameter is required for ALB and NLB load balancing server groups. You cannot configure this parameter in Settings for GWLB load balancing server groups, and the default value is 6081.	22

Response elements

Element	Type	Description	Example
	object
ScalingActivityId	string	The ID of the scaling activity that is triggered when the load balancing server group is added and the existing ECS instances or ECI instances in the scaling group are added to the server group. Note This parameter is returned only when ForceAttach is set to true.	asa-bp1c9djwrgxjyk31****
RequestId	string	The request ID.	74C4E313-8570-479F-8791-DC25360D****

Examples

Success response

JSON format

{
  "ScalingActivityId": "asa-bp1c9djwrgxjyk31****",
  "RequestId": "74C4E313-8570-479F-8791-DC25360D****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.