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
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ess:AttachServerGroups |
update |
*ScalingGroup
|
None | 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 |
Ensures the idempotence of the request. The client generates a parameter value to ensure that the value is unique across different requests. The value 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 ECI instances in the current scaling group to the newly added server groups. Valid values:
Default value: false. |
false |
| ServerGroup |
array<object> |
Yes |
The details of the load balancing server groups. |
|
|
object |
No |
The details of 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 |
| Weight |
integer |
No |
The weight of the 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 system will allocate more access requests to the ECS instance or ECI instance. If the weight is set to 0, the ECS instance or ECI instance does not receive access requests. Note
This parameter is required for ALB and NLB load balancing. The Settings for this parameter are not supported for GWLB load balancing. |
100 |
| Port |
integer |
No |
The port number used by the 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. The Settings for this parameter are not supported for GWLB load balancing, 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 groups are added and the ECS instances or ECI instances in the scaling group are added to the server groups. Note
This parameter is returned only when ForceAttach is set to true. |
asa-bp1c9djwrgxjyk31**** |
| RequestId |
string |
The ID of the request. |
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.