RemoveServersFromServerGroup - Server Load Balancer - Alibaba Cloud Documentation Center

Removes backend servers from a server group.

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 a server group is in the Configuring state, it indicates that the server group is being modified.
- If a server group is in the Available state, it indicates that the server group is running.
You can call the ListServerGroupServers operation to query the status of a backend server.
- If a backend server is in the Removing state, the server is being removed from the server group.
- If a backend server cannot be found, the server is no longer in the server group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The server group ID.	sgp-atstuj3rtop****
Servers	array<object>	Yes	The backend servers that you want to remove from the server group. You can specify up to 40 backend servers in each call.
	object	Yes	The configurations of the backend server group.
Port	integer	No	The port that is used by the backend server. Valid values: 1 to 65535. You can specify at most 40 servers in each call. Note This parameter is required if the ServerType parameter is set to Ecs, Eni, Eci, or Ip.	80
ServerId	string	Yes	The backend server ID. You can specify up to 40 server IDs in each call. If the server group type is Instance, set the ServerId parameter to the ID of an ECS instance, an ENI, or an elastic container instance. These backend servers are specified by Ecs, Eni, or Eci. If the server group type is Ip, set the ServerId parameter to an IP address specified in the server group. If the server group type is Fc, set the ServerId parameter to the ARN of a function specified in the server group. Note You can call the ListServerGroups operation to query information about the server group type so that you can set ServerId to a proper value.	i-bp1f9kdprbgy9uiu****
ServerIp	string	No	The IP address in inclusive ENI mode. You can specify at most 40 servers in each call.	192.168.1.1
ServerType	string	Yes	The type of the backend server. You can specify at most 40 servers in each call. Valid values: Ecs Eni Eci Ip Fc	Ecs
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 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.	593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
JobId	string	The asynchronous task ID.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	ResourceInConfiguring.BackendServer	The specified resource of %s is being configured, please try again later.	The specified resource of %s is being configured, please try again later.
400	ResourceInConfiguring	The specified resource of %s is being configured. Please try again later.	-
403	Forbidden.ServerGroup	Authentication is failed for ServerGroup.	-
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.BackendServer	The specified resource %s is not found.	The specified resource %s is not found.

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

Change history

Change time	Summary of changes	Operation
2024-01-29	The Error code has changed	View Change Details
2024-01-24	The Error code has changed	View Change Details
2024-01-17	The Error code has changed	View Change Details