Get the status list of virtual servers in given load balancer service

Returns the status list of virtual servers in given load balancer service.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/services/<service-id>/virtual-servers/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/virtual-servers/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbVirtualServerStatusListResult+

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 virtual servers	array of LbVirtualServerStatus	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" : [ { "virtual_server_id" : "6be3337b-42c9-4ad6-8184-82ecb7a3234d", "status" : "UP" }, { "virtual_server_id" : "19ba1f6b-09d7-43df-ae1e-4d491d766d20", "status" : "UP" } ] }

Required Permissions:

read

Feature:

lb_virtual_servers

Additional Errors:

301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable