RemoveServersFromServerGroup - Server Load Balancer - Alibaba Cloud Documentation Center

Removes backend servers from the server group of a Gateway Load Balancer (GWLB) instance.

Operation description

RemoveServersFromServerGroup 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 a 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 a backend server.
- If the backend server is in the Removing state, the backend server is being removed from the server group.
- If the backend server cannot be found, the backend server is no longer in the server group.

Note

If connection draining id enabled (ConnectionDrainEnabled set to true) for the server group of the backend server, the backend server that you remove enters the Removing state before entering the Draining state. When the connection draining timeout period (ConnectionDrainTimeout) ends, the backend server is removed from the server group.
You can add the backend server to the server group again before the connection draining timeout period ends. In this case, the status of the backend server changes from Draining to Adding. After the backend server is added to the server group, the backend server enters the Available state.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
gwlb:RemoveServersFromServerGroup	delete	All Resources *	none	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 remove. Note You can remove 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	6081
ServerId	string	Yes	The backend server ID. If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type. If the server group is of the Ip type, set ServerId to IP addresses.	i-bp67acfmxazb4p****
ServerIp	string	No	The IP address of the backend server.	192.168.xxx.xxx
ServerType	string	Yes	The type of the backend server. Valid values: Ecs: Elastic Compute Service (ECS) instance Eni: elastic network interface (ENI) Eci: elastic container instance Ip: IP address	Ecs
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	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-42665544****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Sample success responses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.BackendServer	The status of %s [%s] is incorrect.	The current operation cannot be performed on the server as its status is unavailable. Please check if the server is currently undergoing any other operations.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
404	ResourceNotFound.BackendServer	The specified resource of %s is not found.	The specified backend server resource does not exist.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group resource does not exist.

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