Get the status list of load balancer pools

Returns the status list of load balancer pools in given load balancer service.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/services/<service-id>/pools/status

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/loadbalancer/services/a0de28f3-c0f7-445c-a624-265175da795d/pools/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbPoolStatusListResult+

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 status list of pools	array of LbPoolStatus	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:

{ "results" : [ { "members" : [ { "port" : "80", "ip_address" : "192.168.1.10", "status" : "UP" }, { "port" : "80", "ip_address" : "192.168.2.10", "status" : "UP" } ], "pool_id" : "029a843e-ae42-4bdf-9f84-8b1f94cb380d", "status" : "UP" }, { "members" : [ { "port" : "9090", "ip_address" : "192.168.1.10", "status" : "UP" }, { "port" : "9090", "ip_address" : "192.168.2.10", "status" : "UP" } ], "pool_id" : "4818b7d5-2bc7-4135-bb25-ae6a4c42a125", "status" : "UP" } ] }

Get the status list of load balancer pools

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

LbPoolStatusListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: