RemoveVServerGroupBackendServers - Server Load Balancer - Alibaba Cloud Documentation Center

Removes one or more backend servers from a specified vServer group.

Operation description

Note If one or more backend servers specified by the BackendServers parameter do not exist in the specified vServer group, these 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.

Debug

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 Resources is 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
slb:RemoveVServerGroupBackendServers	WRITE	instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Classic Load Balancer (CLB) instance is deployed.	cn-hangzhou
VServerGroupId	string	Yes	The ID of the vServer group.	rsp-cige6****
BackendServers	string	Yes	The list of backend servers that you want to remove from the vServer group. You can specify at most 20 backend servers for a vServer group in each call. The value of this parameter is a JSON list of the STRING type. You can specify at most 20 elements in a list for each request. ServerId: the ID of the Elastic Compute Service (ECS) instance or elastic network interface (ENI) that serves as a backend server. Port: the port that is used by the backend server. Valid values: 1 to 65535. Weight: the weight of the backend server. Valid values: 0 to 100. Description: the description of the backend server. The description must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.),and underscores (_). Type: the type of backend server. Valid values: ecs: an ECS instance. This is the default value. eni: an ENI. ServerIp: the IP address of the ECS instance or ENI.	[{ "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" }]

Response parameters

Parameter	Type	Description	Example
	object
VServerGroupId	string	The ID of the vServer group.	rsp-cige6j****
RequestId	string	The ID of the request.	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
BackendServers	object []	The list of backend servers.
Type	string	The type of backend server. Valid values: ecs: an ECS instance eni: an ENI	ecs
Weight	integer	The weight of the backend server.	100
Port	integer	The port that is used by the backend server.	80
ServerId	string	The ID of the ECS instance or ENI.	vm-230

Examples

Sample success responses

JSONformat

{
  "VServerGroupId": "rsp-cige6j****",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 100,
        "Port": 80,
        "ServerId": "vm-230"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history