Get Edge Clusters

Get Edge Clusters

Retrieves all Edge Clusters in the system.

Request
URI
GET
https://{api_host}/cloudapi/vcf/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
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeClusterItems of type(s) application/json;version=40.0
This response body class contains all of the following: InlineEdgeClusterItems0 , InlineEdgeClusterItems1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "status": "string",
            "id": "urn:vcloud:edgeCluster:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "string",
            "description": "string",
            "regionRef": {
                "name": "string",
                "id": "string"
            },
            "deploymentType": "string",
            "nodeCount": 0,
            "orgCount": 0,
            "vpcCount": 0,
            "avgCpuUsagePercentage": "number",
            "avgMemoryUsagePercentage": "number",
            "healthStatus": "string",
            "defaultQosConfig": {
                "ingressProfile": {
                    "id": "string",
                    "name": "string",
                    "type": "string",
                    "committedBandwidthMbps": 0,
                    "burstSizeBytes": 0
                },
                "egressProfile": {
                    "id": "string",
                    "name": "string",
                    "type": "string",
                    "committedBandwidthMbps": 0,
                    "burstSizeBytes": 0
                }
            },
            "backingRef": {
                "id": "string",
                "name": "string"
            }
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/edgeClusters?page=value&pageSize=v
Availability
Added in 40.0
On This Page
Edge Cluster List Operations
GET
Get Edge Clusters
GET
Get Edge Cluster
PUT
Update Edge Cluster
GET
Get Transport Nodes Status
POST
Sync Edge Clusters