Get Edge Clusters
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)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeClusters
COPY
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns EdgeClusters of type(s) application/json;version=38.0
This response body class contains all of the following: Page , InlineEdgeClusters1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"id": "string",
"name": "string",
"description": "string",
"resourcePool": {
"moref": "string",
"clusterMoref": "string",
"name": "string",
"vcId": "string",
"eligible": false,
"kubernetesEnabled": false,
"vgpuEnabled": false
},
"storageProfileName": "string"
}
]
}