NSX-T Data Center REST API

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+
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+

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 } ] }

Required Permissions:

read

Feature:

profiles_cluster_profiles

Additional Errors: