All Products
Search
Document Center

Server Load Balancer:RemoveServersFromServerGroup

Last Updated:Jan 09, 2024

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.

  1. 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.
  2. 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

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.
OperationAccess levelResource typeCondition keyAssociated operation
alb:RemoveServersFromServerGroupWrite
  • ServerGroup
    acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServerGroupIdstringYes

The server group ID.

sgp-atstuj3rtop****
Serversobject []Yes

The backend servers that you want to remove from the server group. You can specify up to 40 backend servers in each call.

PortintegerNo

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
ServerIdstringYes

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****
ServerIpstringNo

The IP address in inclusive ENI mode. You can specify at most 40 servers in each call.

192.168.1.1
ServerTypestringYes

The type of the backend server. You can specify at most 40 servers in each call. Valid values:

  • Ecs
  • Eni
  • Eci
  • Ip
  • Fc
Ecs
ClientTokenstringNo

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
DryRunbooleanNo

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

ParameterTypeDescriptionExample
object

The response parameters.

JobIdstring

The asynchronous task ID.

72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestIdstring

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 codeError codeError messageDescription
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
404ResourceNotFound.ServerGroupThe specified resource %s is not found.The specified resource %s is not found.
404ResourceNotFound.BackendServerThe 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 timeSummary of changesOperation
No change history