NSX-T Data Center REST API

List sub-clusters

Paginated list of all sub-clusters.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/sub-clusters
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/sub-clusters

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
SubClusterListResult+

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "compute_collection_id": "0d25110c-b483-4e6e-95e4-f7b904b297bf:domain-c9", "sub_cluster_info": { "sub_cluster_type": "MANUAL", "discovered_node_ids": [ "57e6560e-acd3-4783-baa0-59143307524b:host-1043", "47e6560e-acd3-4783-baa0-59143307524b:host-1044", "37e6560e-acd3-4783-baa0-59143307524b:host-1045" ] }, "resource_type": "SubCluster", "id": "cluster-1", "display_name": "cluster-1", "path": "/infra/sites/default/enforcement-points/default/sub-clusters/cluster-1", "marked_for_delete": false, "_create_user": "admin", "_create_time": 1607501697823, "_last_modified_user": "admin", "_last_modified_time": 1607582307987, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } ] }

Required Permissions:

read

Feature:

nodes_transport_nodes

Additional Errors: