All Products
Search

This Product

    Server Load Balancer:RemoveServersFromServerGroup

    Document Center

    Server Load Balancer:RemoveServersFromServerGroup

    Last Updated:Sep 10, 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServerGroupIdstringYes

    The server group ID.

    		sgp-atstuj3rtop****
    Serversarray<object>Yes

    The server group. You can add at most 200 backend servers to the server group.

    objectYes

    The configurations of the server group.

    PortintegerNo

    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
    ServerIdstringYes

    The ID of the server group.

    • 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 ServerId to IP addresses.
    • If the server group is of the Fc, 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****
    ServerIpstringNo

    The IP address of the elastic network interface (ENI) in exclusive mode.

    		192.168.1.1
    ServerTypestringYes

    The type of the backend server. Valid values:

    • Ecs: ECS instance
    • Eni: ENI
    • Eci: elastic container instance
    • Ip: IP address
    • Fc: Function Compute
    		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.
    400ResourceInConfiguring.BackendServerThe specified resource of %s is being configured, please try again later.The specified resource of %s is being configured, please try again later.
    400ResourceInConfiguringThe specified resource of %s is being configured. Please try again later.-
    403Forbidden.ServerGroupAuthentication is failed for ServerGroup.-
    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
    2024-01-29The Error code has changedView Change Details
    2024-01-24The Error code has changedView Change Details
    2024-01-17The Error code has changedView Change Details