[{"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 Edge Clusters

Description

Retrieves all Edge Clusters. Results can be filtered by id, name, vCenter (resourcePool.vcId), externalNetworkId and orgVdcId.

  • externalNetworkId - | The URN of external Network. Filters all edgeClusters that are accessible to externalNetworkId. externalNetworkId filter is supported from version 35.2 Example: (externalNetworkId==urn:vcloud:network:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • orgVdcId - | The URN of Org vDC. Filters all edgeClusters that are available to an Org vDC. orgVdcId filter is supported from version 36.0 Example: (orgVdcId==urn:vcloud:vdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
Error will be thrown if both externalNetworkId and orgVdcId filters are supplied.

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
filter Optional

Filter for a query. FIQL format.


integer
page Required

Page to fetch, zero offset.


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 EdgeClusters of type(s) application/json;version=36.3
This response body class contains all of the following: Page, InlineEdgeClusters1

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeClusters?page=10&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
Availability
Added in 32.0
Edge Clusters Operations
Feedback

Was this page helpful?