[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Get Cluster

Description

Get a Cluster

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/clusters/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Cluster ID


Response

Response

Response Body

Response Body

200 OK returns Cluster of type(s) application/json
{
	"hosts": [
		{
			"azName": "string",
			"fqdn": "string",
			"id": "string",
			"ipAddress": "string",
			"vmNics": [
				{
					"isActive": false,
					"isAutoNegotiateSupported": false,
					"isInUse": false,
					"linkSpeedMB": 0,
					"name": "string"
				}
			]
		}
	],
	"id": "string",
	"isDefault": false,
	"isStretched": false,
	"name": "string",
	"primaryDatastoreName": "string",
	"primaryDatastoreType": "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS",
	"vdsSpecs": [
		{
			"isUsedByNsxt": false,
			"name": "string",
			"niocBandwidthAllocationSpecs": [
				{
					"niocTrafficResourceAllocation": {
						"limit": 0,
						"reservation": 0,
						"sharesInfo": {
							"level": "One among: low, normal, high, custom",
							"shares": 0
						}
					},
					"type": "string"
				}
			],
			"portGroupSpecs": [
				{
					"activeUplinks": [
						"string"
					],
					"name": "string",
					"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
				}
			]
		}
	]
}
array of HostReference
hosts Optional

List of hosts associated with the cluster


string
id Optional

ID of the cluster


boolean
isDefault Optional

Status of the cluster if default or not


boolean
isStretched Optional

Status of the cluster if Stretched or not


string
name Optional

Name of the cluster


string
primaryDatastoreName Optional

Name of the primary datastore


string
primaryDatastoreType Optional

Storage type of the primary datastore


array of VdsSpec
vdsSpecs Optional

Distributed switches to added to the cluster

Errors

Errors

404

Cluster not found


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/clusters/{id}


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?