All Products
Search

This Product

    Server Load Balancer:ListServerGroupServers

    Document Center

    Server Load Balancer:ListServerGroupServers

    Last Updated:Oct 26, 2026

    Queries the list of servers in a load balancing 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

    gwlb:ListServerGroupServers

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ServerGroupId

    string

    No

    The ID of the server group.

    sgp-atstuj3rtoptyui****
    ServerIds

    array

    No

    The list of server IDs.

    You can specify up to 200 server IDs in a single call.

    string

    No

    The server ID.

    • If the server group is of the Instance type, this parameter specifies the resource ID of an Ecs, Eni, or Eci resource.

    • If the server group is of the Ip type, this parameter specifies an IP address.

    i-bp67acfmxazb4p****
    ServerIps

    array

    No

    The list of server IP addresses.

    You can specify up to 200 server IP addresses in a single call.

    string

    No

    The server IP address.

    192.168.xxx.xxx
    NextToken

    string

    No

    The pagination token. Valid values:

    • If NextToken is empty, no subsequent query is available.

    • If NextToken has a return value, the value indicates the token used to start the next query.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    MaxResults

    integer

    No

    The number of entries to return per page.

    Valid values: 1 to 1000.

    Default value: 20.

    20
    Skip

    integer

    No

    The number of entries to skip during the query.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    The response struct.

    MaxResults

    integer

    The number of entries returned per page.

    Valid values: 1 to 1000.

    20
    NextToken

    string

    The pagination token. Valid values:

    • You do not need to specify this parameter for the first query or when no subsequent query is available.

    • If a subsequent query is available, the value is the NextToken value returned from the previous API call.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId

    string

    The request ID.

    54B48E3D-DF70-471B-AA93-08E683A1B45
    Servers

    array<object>

    The list of backend servers.

    object

    The backend server.

    Port

    integer

    The port used by the backend server. Valid values:

    • 6081.

    6081
    ServerGroupId

    string

    The ID of the server group.

    sgp-atstuj3rtoptyui****
    ServerId

    string

    The ID of the backend server.

    i-bp67acfmxazb4p****
    ServerIp

    string

    The IP address of the backend server.

    192.168.xxx.xxx
    ServerType

    string

    The backend server type. Valid values:

    • Ecs: ECS instance.

    • Eni: elastic network interface controller (NIC) instance.

    • Eci: Elastic Container Instance (ECI).

    • Ip: IP address.

    Ecs
    Status

    string

    The status of the backend server. Valid values:

    • Adding: The server is being added.

    • Available: The server is available.

    • Draining: Connections are being gracefully drained.

    • Removing: The server is being removed.

    • Replacing: The server is being replaced.

    Available
    TotalCount

    integer

    The total number of entries.

    1

    Examples

    Success response

    JSON format

    {
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "Servers": [
    {
      "Port": 6081,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerId": "i-bp67acfmxazb4p****",
      "ServerIp": "192.168.xxx.xxx",
      "ServerType": "Ecs",
      "Status": "Available"
    }
  ],
  "TotalCount": 1
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.