Retrieve a paginated list of load balancer services

Retrieve a paginated list of load balancer services.
When logical_router_id is specified in request parameters, the
associated load balancer services which are related to the given
logical router returned.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/services

Request Headers:

n/a

Query Parameters:

LbServiceQueryRequestParameters+

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
logical_router_id	Logical router identifier When logical_router_id is specified, the list load balancer API will return the load balancer services which are related to the given logical router.	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/services

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbServiceListResult+

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 load balancer services	array of LbService	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" : 1, "results" : [ { "resource_type" : "LbService", "id" : "4177b474-f147-44f2-b055-73f887742ea1", "display_name" : "lbs1", "size" : "SMALL", "attachment" : { "target_display_name" : "lrouter-2", "is_valid" : true, "target_type" : "LogicalRouter", "target_id" : "6aa3b556-58ad-420a-9b0d-535d3aebf2f5" }, "error_log_level" : "INFO", "access_log_enabled" : false, "virtual_server_ids" : [ "a332950f-472d-4ae3-be03-e7ccefe28fbd" ], "enabled" : true, "_create_time" : 1515745891661, "_last_modified_user" : "admin", "_last_modified_time" : 1515745891661, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 } ] }

Retrieve a paginated list of load balancer services

Request:

LbServiceQueryRequestParameters (schema)

Example Request:

Successful Response:

LbServiceListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: