Adds backend servers to the server group of a Gateway Load Balancer (GWLB) instance.
Operation description
AddServersToServerGroup is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task 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 modified.
- 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 server.
- If the backend server is in the Adding state, the backend server is being added to the server group.
- If the backend server is in the Available state, the server is running.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| gwlb:AddServersToServerGroup | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ServerGroupId | string | Yes | The server group ID. | sgp-atstuj3rtoptyui**** |
| Servers | array<object> | Yes | The backend servers that you want to add. Note
You can add at most 200 backend servers in each call.
| |
| Server | object | Yes | The backend server. | |
| Port | integer | No | The port that is used by the backend server. Valid values:
| 6081 |
| ServerId | string | Yes | The backend server ID.
| i-bp67acfmxazb4p**** |
| ServerIp | string | No | The IP address of the backend server. | 192.168.XX.XX |
| ServerType | string | Yes | The type of the backend server. Valid values:
| Ecs |
| DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| 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 token, but you must make sure that the token 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 request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Conflict.Server | The %s [%s] is conflict. | There is already %s having the same configuration with %s. |
| 400 | Mismatch.ServerType | The %s is mismatched for %s and %s. | ServerType mismatch. |
| 400 | ResourceInUse.IP | The specified resource of %s is in use. | The specified resource of IP is in use. |
| 400 | IllegalParam.ServerIp | The param of %s is illegal. | The parameter ServerIp is invalid. Please check the input parameters. |
| 400 | IllegalParam.EcsNetworkType | The param of %s is illegal. | - |
| 400 | DuplicatedParam.Server | The param of %s is duplicated. | Duplicate server in parameter. |
| 400 | ResourceInUse.Eni | The specified resource of %s is in use. | The passed-in eni cannot be the eni used by the gateway loadbalancer instance.Please check the parameters. |
| 400 | IncorrectStatus.Eni | The status of %s [%s] is incorrect. | Resource %s current state %s does not support operation |
| 400 | IllegalParam.IP | The param of %s is illegal. | The parameter IP is invalid. Please check the input value of the parameter IP. |
| 400 | Mismatch.IP | The %s is mismatched for %s and %s. | The entered IP type server ID and IP do not match. |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | The VPC IDs of the two resources do not match. |
| 400 | QuotaExceeded.ServerGroupServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | The quota gwlb_quota_servergroup_servers_num has exceeded the quota limit. |
| 400 | QuotaExceeded.ServerGroupAzServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | The quota gwlb_quota_servergroup_az_servers_num has exceeded the quota limit. |
| 404 | ResourceNotFound.Ecs | The specified resource of %s is in use. | The specified elastic compute service resource does not exist. |
| 404 | ResourceNotFound.Eni | The specified resource of %s is not found. | The specified elastic network interfaces resource does not exist. |
| 404 | ResourceNotFound.Eci | The specified resource of %s is not found. | The specified elastic container instance resource does not exist. |
For a list of error codes, visit the Service error codes.