Adds 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 servers that you want to add. You can add up to 40 servers at a time.

Description String No test

The description of the server. The description must be 2 to 256 characters in length.

Port Integer No 80

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

Note This parameter is required if the server type is Ecs, Eni, or Eci.
ServerId String Yes ecs-bp67acfmxazb4p****

The ID of the ECS instance, ENI instance, or ECI instance.

ServerIp String No 192.168.1.1

The IP address of the ENI instance when the instance is in the inclusive ENI mode.

ServerType String No Ecs

The server type. Valid values:

  • Ecs (default): The server is an ECS instance.
  • Eni: The server is an ENI instance.
  • Eci: The server is an ECI instance.
Weight Integer No 100

The weight of the server. Valid values: 0 to 100. Default value: 100. If the value is set to 0, no requests are forwarded to the server.

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

The client token that is used to ensure the idempotency. You can use the client to generate the value, but you must ensure 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 may be unique.
DryRun Boolean No true

Specifies whether to precheck the API request. Valid values:

  • true: only prechecks the API request. If you select this option, the specified endpoint service is not created after the request passes the precheck. The system prechecks the required parameters, request format, and service limits. If the request fails the check, the corresponding error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): checks the request. After the request passes the check, an HTTP_2xx status code is returned and the operation is performed.

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

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

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