Get Edge Cluster
Retrieves a specific Edge Cluster.
Request
URI
GET
https://{api_host}/cloudapi/vcf/edgeClusters/{edgeClusterId}
COPY
Path Parameters
string
edgeClusterId
Required
edgeClusterId
Responses
200
OK
Returns
EdgeClusterItem
of type(s)
application/json;version=40.0
This response body class contains all of the following:
InlineEdgeClusterItem0 ,
InlineEdgeClusterItem1
{
"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/{edgeClusterId}
Availability
Added in 40.0
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