Retrieve a paginated list of load balancer virtual servers

Retrieve a paginated list of load balancer virtual servers.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/virtual-servers

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/virtual-servers

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbVirtualServerListResult+

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 virtual servers	array of LbVirtualServer	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" : "LbVirtualServer", "id" : "a332950f-472d-4ae3-be03-e7ccefe28fbd", "display_name" : "vs1", "ip_address" : "192.168.100.101", "ports" : [ "80" ], "pool_id" : "bf972923-9c40-4183-9a27-8e02d138e8e2", "enabled" : true, "ip_protocol" : "TCP", "port" : "80", "access_log_enabled" : false, "application_profile_id" : "cb2d0721-cc15-5b8e-8633-14be114eac5e", "_create_time" : 1515662800997, "_last_modified_user" : "admin", "_last_modified_time" : 1515662800997, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 }, { "resource_type" : "LbVirtualServer", "id" : "64150185-d351-4f9f-9580-f4ea97fec257", "display_name" : "vs2", "ip_address" : "192.168.100.102", "ports" : [ "80" ], "pool_id" : "bf972923-9c40-4183-9a27-8e02d138e8e2", "enabled" : true, "ip_protocol" : "TCP", "port" : "80", "access_log_enabled" : false, "application_profile_id" : "cb2d0721-cc15-5b8e-8633-14be114eac5e", "_create_time" : 1515663142970, "_last_modified_user" : "admin", "_last_modified_time" : 1515663224934, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 1 } ] }

Retrieve a paginated list of load balancer virtual servers

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

LbVirtualServerListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: