RemoveServersFromServerGroup - Remove NLB backend servers - Server Load Balancer

Removes backend servers from a Network Load Balancer (NLB) server group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nlb:RemoveServersFromServerGroup

delete

*ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The server group ID.	sgp-atstuj3rtoptyui****
Servers	array<object>	Yes	The backend servers. Up to 200 servers per call.
	object	No	The backend server.
ServerId	string	Yes	The backend server ID. Instance server group: the ID of an Ecs, Eni, or Eci server. Ip server group: an IP address.	ecs-bp67acfmxazb4p****
ServerType	string	Yes	The type of the backend server. Valid values: Ecs: the Elastic Compute Service (ECS) instance Eni: the elastic network interface (ENI) Eci: the elastic container instance Ip: the IP address	Ecs
ServerIp	string	No	The IP address of the backend server. Applicable when the server group type is Ip.	192.168.6.6
Port	integer	No	The port of the backend server. Valid values: 0 to 65535. Default value: 0.	443
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system validates the request without performing the operation. If validation fails, an error message is returned. If validation succeeds, the `DryRunOperation` error code is returned. false (default): sends the request. A 2xx HTTP status code is returned on success.	false
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token. The token must be unique across requests and contain only ASCII characters. Note If you do not set this parameter, the system uses RequestId as the client token. Each request has a different RequestId.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The region ID of the NLB instance. You can call the DescribeRegions operation to query available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Removes backend servers from a server group.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	The server group ID.	sgp-atstuj3rtoptyui****
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Conflict.Lock	The Lock [%s] is conflict.	A resource conflict occurred.
400	IncorrectStatus.serverGroup	The status of servergroup [%s] is incorrect.	The server group is in an unavailable state. Verify that no other operations are in progress on the server group.
400	IllegalParam.%s	The param of %s is illegal.
400	SystemBusy	System is busy, please try again later.
400	IdempotenceSignatureMismatch	The idempotence token of request is same with the prev one, but the signature is different.	The requested idempotent token is the same as the previous one, but the signature is different.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	You do not have the required permissions to perform this operation.
404	ResourceNotFound.BackendServer	The specified resource of BackendServer is not found.	The specified backend server was not found. Verify the input parameters.
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.	The specified server group was not found. Verify the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.