Adds backend servers to a specified server group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddServersToServerGroup

The operation that you want to perform. Set the value to AddServersToServerGroup.

ServerGroupId String Yes sgp-atstuj3rtop****

The ID of the server group.

Servers Array Yes

The backend servers that you want to add to the server group. You can specify up to 40 servers in each call.

Description String No test

The description of the backend server. The description must be 2 to 256 characters in length, and can contain only the characters specified by the following expression: /^([^\x00-\xff]|[\w.,;/@-]){2,256}$/.

Port Integer No 80

The port that is used by the backend server. Valid values: 1 to 65535.

Note This parameter is required if the ServerType parameter is set to Ecs, Eni, Eci, or Ip.
ServerId String Yes ecs-bp67acfmxazb4p****

If the server group consists of servers, you can set this parameter to the ID of a resource, such as an Elastic Compute Service (ECS) instance, an elastic network interface (ENI), or an elastic container instance.

If the server group consists of IP addresses, you can set this parameter to an IP address.

ServerIp String No 192.168.1.1

The IP address of the ENI in inclusive ENI mode.

ServerType String Yes Ecs

The type of the backend server. Valid values:

  • Ecs: an ECS instance
  • Eni: an ENI
  • Eci: an elastic container instance
  • Ip: an IP address
Weight Integer No 100

The weight of the backend server. Valid values: 0 to 100. Default value: 100. A value of 0 indicates that no requests are forwarded to the backend server.

ClientToken String No 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3

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 make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The ID of each request is unique.
DryRun Boolean No true

Specifies whether only to precheck the request. Valid values:

  • true: only prechecks the request and does not perform the requested operation. The system checks the required parameters, request format, and service limits. If the request fails the precheck, an error code is returned based on the cause of the failure. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: prechecks the request and performs the requested operation. After the request passes the precheck, an HTTP 2xx status code is returned and the system performs the operation. This is the default value.

Response parameters

Parameter Type Example Description
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

The ID of the asynchronous task.

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AddServersToServerGroup
&ServerGroupId=sgp-atstuj3rtop****
&Servers=[{"Description":"test","Port":80,"ServerId":"ecs-bp67acfmxazb4p****","ServerIp":"192.168.1.1","ServerType":"Ecs","Weight":100}]
&ClientToken=593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
&DryRun=true
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<AddServersToServerGroupResponse>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
</AddServersToServerGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

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 error message returned because the usage %s of the specified %s resource has exceeded the quota %s.
400 IncorrectStatus.ServerGroup The status of %s [%s] is incorrect. The error message returned because the status of the server group is invalid.
400 Conflict.BackendServer There is already %s having the same configuration with %s. The error message returned because an existing %s has the same configuration.
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 error message returned because the status of the specified %s [%s] resource is invalid.
400 ResourceInUse.IP The specified resource %s is in use. The error message returned because the specified %s resource is in use.
400 OperationDenied.NoAvailableVSwitch The operation is not allowed because of %s. The error message returned because the operation is not allowed due to %s.
400 OperationDenied.VgwVipNotFound The operation is not allowed because of %s. The error message returned because the operation is not allowed due to %s.
400 OperationDenied.CloudBox The operation is not allowed because of %s. The error message returned because the operation is not allowed due to %s.
400 Mismatch.Type The %s is mismatched for %s and %s. The error message returned because the specified %s does not correspond to the specified %s and %s.
400 Mismatch.VpcId The %s is mismatched for %s and %s. The error message returned because the specified %s does not correspond to the specified %s and %s.
404 ResourceNotFound.ServerGroup The specified resource %s is not found. The error message returned because the specified %s resource does not exist.
404 ResourceNotFound.Ecs The specified resource %s is not found. The error message returned because the specified %s resource does not exist.
404 ResourceNotFound.Eci The specified resource %s is not found. The error message returned because the specified %s resource does not exist.
404 ResourceNotFound.Eni The specified resource %s is not found. The error message returned because the specified %s resource does not exist.
404 ResourceNotFound.BackendServer The specified resource %s is not found. The error message returned because the specified %s resource does not exist.

For a list of error codes, visit the API Error Center.