Removes a backend server from a specified vServer group.

Note If one or more backend servers specified by BackendServers do not exist in the vServer group, the backend servers are ignored and no error message is returned.

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 RemoveVServerGroupBackendServers

The operation that you want to perform.

Set the value to RemoveVServerGroupBackendServers.

BackendServers String Yes [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port":"80","Description":"test-113" }]

The list of backend servers that you want to remove from the vServer group.

A vServer group can contain a maximum of 20 backend servers in each request.

The value of this parameter is a JSON list of the String type. You can specify up to 20 elements in a list for each request.

  • ServerId: Required. Specify the ID of an Elastic Compute Service (ECS) instance or elastic network interface (ENI). This parameter is of the String type.
  • Port: the port that is used by the backend server. This parameter is required and must be set to an integer. Valid values: 1 to 65535.
  • Weight: the weight of the backend server. This parameter is required and must be set to an integer. Valid values: 0 to 100.
  • Description: the description of the backend server. This parameter is optional and must be set to a string. The description must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.),and underscores (_).
  • Type: Specify the type of the backend server. This parameter must be of the String type. Valid values:
    • ecs: An ECS instance. This is the default value.
    • eni: an ENI.
  • ServerIp: The IP address of the ECS instance or ENI.
RegionId String Yes cn-hangzhou

The ID of the region where the SLB instance is deployed.

VServerGroupId String Yes rsp-cige6****

The ID of the backend server group.

ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

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 token can contain only ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
VServerGroupId String rsp-cige6j*****

The ID of the server group.

BackendServers Array of BackendServer

The list of backend servers.

BackendServer
ServerId String vm-230

The ID of the ECS instance or ENI.

Port Integer 80

The port that is used by the backend server.

Weight Integer 100

The weight of the backend server.

Type String ecs

Type: the type of backend server. Valid values:

  • ecs: an ECS instance. This is the default value.
  • eni: an ENI.
RequestId String 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=RemoveVServerGroupBackendServers
&BackendServers=[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port":"80","Description":"test-113" }]
&RegionId=cn-hangzhou
&VServerGroupId=rsp-cige6******
&<Common request parameters>

Sample success responses

XML format

<RemoveVServerGroupBackendServersResponse>
	  <RequestId>9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C</RequestId>
	  <VServerGroupId>rsp-cige6******</VServerGroupId>
	  <BackendServers>
		    <BackendServer>
			      <ServerId>vm-231</ServerId>
			      <Port>70</Port>
			      <Weight>100</Weight>
                              <Type>ecs</Type>
		    </BackendServer>
	  </BackendServers>
</RemoveVServerGroupBackendServersResponse>

JSON format

{
  "RemoveVServerGroupBackendServersResponse": {
    "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
    "VServerGroupId": "rsp-cige6******",
    "BackendServers": {
      "BackendServer": {
        "ServerId": "vm-231",
        "Port": "70",
        "Weight": "100",
        "Type": "ecs"
      }
    }
  }
}

Error codes

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