Retrieve a paginated list of load balancer persistence profiles

Retrieve a paginated list of load balancer persistence profiles.

Request:

Method:

GET

URI Path(s):

/api/v1/loadbalancer/persistence-profiles

Request Headers:

n/a

Query Parameters:

LbPersistenceProfileListRequestParameters+

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
type	Load balancer persistence profile type Specify this type parameter to retrieve a list of load balancer persistence profiles of specified type.	PersistenceProfileType

Request Body:

n/a

Example Request:

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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LbPersistenceProfileListResult+

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 persistence profiles	array of LbPersistenceProfile (Abstract type: pass one of the following concrete types) LbCookiePersistenceProfile LbGenericPersistenceProfile LbSourceIpPersistenceProfile	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" : 3, "results" : [ { "resource_type" : "LbCookiePersistenceProfile", "id" : "4a19c81d-2622-4c9a-b79a-39587b172e7b", "display_name" : "lb-persistence-profile1", "persistence_shared" : false, "cookie_mode" : "INSERT", "cookie_garble" : true, "cookie_fallback" : true, "cookie_name" : "LoadBalancer", "_create_time" : 1515742393690, "_last_modified_user" : "admin", "_last_modified_time" : 1515742393690, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 }, { "resource_type" : "LbCookiePersistenceProfile", "id" : "d7556195-bd1e-5d3a-97f6-82accb2e19ac", "display_name" : "nsx-default-cookie-persistence-profile", "persistence_shared" : false, "cookie_mode" : "INSERT", "cookie_garble" : true, "cookie_fallback" : true, "cookie_name" : "NSXLB", "_create_time" : 1515651381460, "_last_modified_user" : "system", "_last_modified_time" : 1515651381460, "_system_owned" : true, "_create_user" : "system", "_protection" : "NOT_PROTECTED", "_revision" : 0 }, { "resource_type" : "LbSourceIpPersistenceProfile", "id" : "2a176906-fc94-584a-b1a7-20333434f6eb", "display_name" : "nsx-default-source-ip-persistence-profile", "persistence_shared" : false, "purge" : "FULL", "timeout" : 300, "ha_persistence_mirroring_enabled" : false, "_create_time" : 1515651381495, "_last_modified_user" : "system", "_last_modified_time" : 1515651381495, "_system_owned" : true, "_create_user" : "system", "_protection" : "NOT_PROTECTED", "_revision" : 0 } ] }

Retrieve a paginated list of load balancer persistence profiles

Request:

LbPersistenceProfileListRequestParameters (schema)

Example Request:

Successful Response:

LbPersistenceProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: