Retrieve a paginated list of load balancer pools

Retrieve a paginated list of load balancer pools.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/pools

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/loadbalancer/pools

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbPoolListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	paginated list of pools	array of LbPool	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count" : 2, "results" : [ { "resource_type" : "LbPool", "description" : "LB_HTTP_Pool", "id" : "637ad18e-ebd3-43d0-b9e8-e9fc5a4af828", "display_name" : "LB_HTTP_Pool", "min_active_members" : 1, "tcp_multiplexing_number" : 6, "members" : [ { "weight" : 1, "admin_state" : "ENABLED", "ip_address" : "192.168.100.160", "display_name" : "Member_VM30", "backup_member" : false }, { "weight" : 1, "admin_state" : "ENABLED", "ip_address" : "192.168.100.161", "display_name" : "Member_VM31", "backup_member" : false }, { "weight" : 1, "admin_state" : "ENABLED", "ip_address" : "192.168.100.162", "display_name" : "Member_VM32", "backup_member" : false } ], "active_monitor_ids" : [ "ab1c038f-565a-4870-a61c-b731f99f0bb4" ], "tcp_multiplexing_enabled" : false, "algorithm" : "ROUND_ROBIN", "_create_time" : 1515739241530, "_last_modified_user" : "admin", "_last_modified_time" : 1515739241530, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 }, { "resource_type" : "LbPool", "id" : "bf972923-9c40-4183-9a27-8e02d138e8e2", "display_name" : "pool1", "min_active_members" : 1, "tcp_multiplexing_number" : 6, "members" : [ { "port" : "80", "weight" : 1, "admin_state" : "ENABLED", "ip_address" : "192.168.1.10", "display_name" : "192.168.1.10", "backup_member" : false } ], "tcp_multiplexing_enabled" : false, "algorithm" : "ROUND_ROBIN", "_create_time" : 1515653475106, "_last_modified_user" : "admin", "_last_modified_time" : 1515653475106, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 } ] }

Retrieve a paginated list of load balancer pools

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

LbPoolListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: