Adds backend servers to a server group.
Operation description
The AddServersToServerGroup operation is asynchronous. After you send the request, the system returns a request ID, but the backend servers are not immediately added. The addition task is still running in the background.
You can call the ListServerGroups operation to query the status of the server group:
If the server group is in the Configuring state, the server group is being reconfigured.
If the server group is in the Available state, the server group is running.
You can call the ListServerGroupServers operation to query the status of the backend servers:
If a backend server is in the Adding state, the backend server is being added to the server group.
If a backend server is in the Available state, the backend server is running.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:AddServersToServerGroup |
create |
*ServerGroup
Instance
NetworkInterface
ContainerGroup
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ServerGroupId |
string |
Yes |
The ID of the server group. |
sgp-atstuj3rtop**** |
| Servers |
array<object> |
Yes |
The list of backend servers. You can add up to 200 servers in a single call. |
|
|
object |
No |
The backend server group structure. |
||
| Description |
string |
No |
The description of the backend server. The description must be 2 to 256 characters in length, and cannot start with http:// or https://. |
test |
| Port |
integer |
No |
The port used by the backend server. Valid values: 1 to 65535. You can add up to 200 servers in a single call. Note
This parameter is required when ServerType is set to Ecs, Eni, Eci, or Ip. This parameter is not required when ServerType is set to Fc. |
80 |
| ServerId |
string |
No |
The ID of the backend server. You can add up to 200 servers in a single call.
|
i-uf616vu8me****** |
| ServerIp |
string |
No |
The specified IP address. You can add up to 200 servers in a single call. If ServerType is set to Eni, you can specify the primary or secondary private IP address of the ENI. Note
This parameter is not required when ServerType is set to Fc. |
192.168.1.1 |
| ServerType |
string |
Yes |
The backend server type. You can add up to 200 servers each time you invoke the operation. Valid values:
|
Ecs |
| Weight |
integer |
No |
The weight of the backend server. Valid values: 0 to 100. Default value: 100. If the weight is set to 0, no requests are forwarded to the backend server. You can add up to 200 servers in a single call. Note
This parameter is not required when ServerType is set to Fc. |
100 |
| RemoteIpEnabled |
boolean |
No |
Specifies whether to enable the remote IP address feature. You can add up to 200 servers in a single call. Valid values:
Note
This parameter takes effect only when ServerType is set to Ip. |
false |
| 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 ensure that it is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique. |
593B0448-D13E-4C56-AC0D-FDF0****** |
| DryRun |
boolean |
No |
Specifies whether to only precheck the request. Valid values:
|
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data structure. |
||
| JobId |
string |
The ID of the asynchronous task. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
The ID of the request. |
365F4154-92F6-4AE4-92F8-7FF34****** |
Examples
Success response
JSON format
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | The number of servers added to the server group exceeds the quota limit. |
| 400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | The status of %s [%s] is incorrect. |
| 400 | Conflict.BackendServer | There is already %s having the same configuration with %s. | Server conflict. A backend server with the same configuration already exists. |
| 400 | OperationDenied.VpcVportNotFound | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | IncorrectStatus.Eni | The status of %s [%s] is incorrect. | The status of %s [%s] is incorrect. |
| 400 | ResourceInUse.IP | The specified resource %s is in use. | The specified resource %s is in use. |
| 400 | OperationDenied.NoAvailableVSwitch | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | OperationDenied.VgwVipNotFound | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | OperationDenied.CloudBox | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | Mismatch.Type | The %s is mismatched for %s and %s. | The %s is mismatched for %s and %s. |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | The %s is mismatched for %s and %s. |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | The number of backend servers has exceeded the quota limit. |
| 400 | ResourceInConfiguring | The specified resource of %s is being configured. Please try again later. | The specified resource is being modified. Try again later. |
| 400 | DuplicatedParam.BackendServer | The param of %s is duplicated. | The param of %s is duplicated. |
| 400 | OperationDenied.EciNotSupportJobType | The operation is not allowed because of eci not support job type. | The operation is not allowed because of eci not support job type. |
| 400 | IllegalParam.ServerIp | The param of ServerIp is illegal. | The parameter ServerIp is invalid. |
| 400 | Mismatch.ServerType | The %s is mismatched for %s and %s. | The %s does not match between %s and %s. |
| 400 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | The request has failed due to a temporary failure of the server. |
| 403 | Forbidden.ServerGroup | Authentication has failed for ServerGroup. | Authentication failed for the ServerGroup. |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | The backend server group does not exist. |
| 404 | ResourceNotFound.Ecs | The specified resource %s is not found. | The ECS server does not exist. |
| 404 | ResourceNotFound.Eci | The specified resource %s is not found. | The ECI server does not exist. |
| 404 | ResourceNotFound.Eni | The specified resource %s is not found. | The specified resource %s is not found. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.