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 ListServerGroups 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 ListServerGroupServers 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.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
alb:RemoveServersFromServerGroup	update	*ServerGroup `acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}` Instance `acs:alb:{#regionId}:{#accountId}:ecs/{#InstanceId}` NetworkInterface `acs:alb:{#regionId}:{#accountId}:eni/{#NetworkInterfaceId}` ContainerGroup `acs:alb:{#regionId}:{#accountId}:eci/{#ContainerGroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The server group ID.	sgp-atstuj3rtop****
Servers	array<object>	Yes	The backend servers to be removed. You can specify up to 200 backend servers.
	object	Yes	The configurations of the backend server.
Port	integer	No	The port that is used by the backend server. Valid values: 1 to 65535. Note This parameter is required when you set ServerType to Ecs, Eni, Eci, or Ip.	80
ServerId	string	Yes	The backend server ID. If the server group is of the Instance type, set ServerId to the ID of a resource of the Ecs, Eni, or Eci type. If the server group is of the Ip type, set this parameter to IP addresses. If the server group is of the Fc type, set ServerId to the Alibaba Cloud Resource Name (ARN) of a function. 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 of the elastic network interface (ENI) in inclusive mode.	192.168.1.1
ServerType	string	Yes	The type of the backend server. Valid values: Ecs: Elastic Compute Service (ECS) instance Eni: ENI Eci: elastic container instance Ip: IP address Fc: Function Compute instance	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.	-
404	ResourceNotFound.BackendServer	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