Get Edge Cluster
Retrieves a specific Edge Cluster
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeClusters/{edgeClusterId}
COPY
Path Parameters
string
edgeClusterId
Required
edgeClusterId
string
edgeClusterId
Required
edgeClusterId
Responses
200
OK
Returns EdgeCluster of type(s) application/json;version=38.0
{
"id": "string",
"name": "string",
"description": "string",
"resourcePool": {
"moref": "string",
"clusterMoref": "string",
"name": "string",
"vcId": "string",
"eligible": false,
"kubernetesEnabled": false,
"vgpuEnabled": false
},
"storageProfileName": "string"
}
string
id
Optional
The id of the Edge Cluster in URN format.
string
name
Required
The name of the Edge Cluster. Names for Edge Clusters must be unique across the system.
string
description
Optional
description
string
storageProfileName
Required
Name of the Storage Profile. This will define the set of datastores where the edge vm will be deployed.
404
The specified resource was not found
Returns Error of type(s) application/json;version=38.0
{
"minorErrorCode": "string",
"message": "string",
"stackTrace": "string"
}
string
minorErrorCode
Required
minorErrorCode
string
message
Required
message
string
stackTrace
Optional
stackTrace
Availability
Added in 32.0
Edge Cluster Operations
DELETE
Delete Edge Cluster
GET
Get Edge Cluster
PUT
Update Edge Cluster