[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get NSX-T Edge Clusters

Description

Returns all the configured NSX-T edge clusters for an Org vDC or a VDC Group or a Provider VDC. Supported filters are:

  • orgVdcId - | The filter orgVdcId must be set equal to the id of the NSX-T backed Org vDC for which we want to get the edge clusters. Example: (orgVdcId==urn:vcloud:vdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • vdcGroupId - | The filter vdcGroupId must be set equal to the id of the NSX-T VDC Group for which we want to get the edge clusters. Example: (vdcGroupId==urn:vcloud:vdcGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • pvdcId - | The filter pvdcId must be set equal to the id of the NSX-T backed Provider VDC for which we want to get the edge clusters. pvdcId filter is supported from version 35.2 Example: (pvdcId==urn:vcloud:providervdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
Use of "_context" filter has been deprecated. Please use supported filters.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/nsxTResources/edgeClusters
Copy

Query Parameters

Query Parameters

string
cursor Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.


string
filter Optional

Filter for a query. FIQL format.


integer
pageSize Required

Results per page to fetch.


string
sortAsc Optional

Field to use for ascending sort


string
sortDesc Optional

Field to use for descending sort


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns NsxTEdgeClusters of type(s) application/json;version=36.3
{
	"values": [
		{
			"deploymentType": "enum",
			"description": "string",
			"id": "string",
			"name": "string",
			"nodeCount": 0,
			"nodeType": "enum"
		}
	]
}
array of NsxTEdgeCluster
values Optional

Information about a configured edge cluster on an NSX-T manager. An Edge cluster is a group of edge transport nodes.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/nsxTResources/edgeClusters?pageSize=10


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?