List Cluster Profiles

Returns paginated list of cluster profiles
Cluster profiles define policies for edge cluster and bridge cluster.

Request:

Method:

GET

URI Path(s):

/api/v1/cluster-profiles

Request Headers:

n/a

Query Parameters:

ClusterProfileListParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_system_owned	Whether the list result contains system resources	boolean	Default: "True"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
resource_type	Type of cluster profile	ClusterProfileType
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster-profiles?include_system_owned=false

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ClusterProfileListResult+

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	Cluster Profile Results	array of ClusterProfile (Abstract type: pass one of the following concrete types) BridgeHighAvailabilityClusterProfile EdgeHighAvailabilityProfile	Readonly
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": "EdgeHighAvailabilityProfile", "description": "", "id": "a73723d4-24d5-4ea8-97a5-6c1a3853e838", "display_name": "edge-cluster-profile-West", "tags": [], "bfd_probe_interval": 2000, "bfd_declare_dead_multiple": 9, "bfd_allowed_hops": 3, "standby_relocation_config": { "standby_relocation_threshold": 40 }, "_last_modified_time": 1458585189556, "_create_time": 1458585189556, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 } ] }

List Cluster Profiles

Request:

ClusterProfileListParameters (schema)

Example Request:

Successful Response:

ClusterProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: