[{"label":"Latest (v36.3)","version":"latest"},{"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 Cluster

Description

Retrieves a specific Edge Cluster

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
edgeClusterId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns EdgeCluster of type(s) application/json;version=36.3
{
	"description": "string",
	"id": "string",
	"name": "string",
	"resourcePool": {
		"clusterMoref": "string",
		"eligible": false,
		"kubernetesEnabled": false,
		"moref": "string",
		"name": "string",
		"vcId": "string",
		"vgpuEnabled": false
	},
	"storageProfileName": "string"
}
string
name Required

The name of the Edge Cluster. Names for Edge Clusters must be unique across the system.


string
storageProfileName Required

Name of the Storage Profile. This will define the set of datastores where the edge vm will be deployed.


string
description Optional

string
id Optional

The id of the Edge Cluster in URN format.


resourcePool Optional

The Resource Pool in vCenter where the Edge VM will be deployed.

Errors

Errors

404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeClusters/{edgeClusterId}


[{"label":"Latest (v36.3)","version":"latest"},{"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
Feedback

Was this page helpful?