ListServerGroupServers - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the servers in a Server Load Balancer 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 support 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

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 each call.
	string	No	The server ID. If the server group is of the Instance type, this parameter specifies the resource ID of an ECS instance, an elastic network interface (ENI), or an elastic container instance (ECI). 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 each call.
	string	No	The IP address of the server.	192.168.xxx.xxx
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that is used to retrieve the next page.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 1000. Default value: 20.	20
Skip	integer	No	The number of entries to skip.	1

Response parameters

Parameter	Type	Description	Example
	object	The data structure of the response.
MaxResults	integer	The number of entries returned per page. Valid values: 1 to 1000.	20
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request or if no next page exists. If a next page exists, set the value to the NextToken value that is returned in the last 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 type of the backend server. Valid values: Ecs: an ECS instance. Eni: an elastic network interface (ENI). Eci: an elastic container instance (ECI). Ip: an IP address.	Ecs
Status	string	The status of the backend server. Valid values: Adding: The backend server is being added. Available: The backend server is running as expected. Draining: Connections to the backend server are being drained. Removing: The backend server is being removed. Replacing: The backend server is being replaced.	Available
TotalCount	integer	The number of entries in the list.	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.