[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"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 Clusters

Description

Get the Clusters

Request

URL

get

https://sfo-vcf01.rainpole.io/v1/clusters

Copy

Query Parameters

boolean

isStretched Optional

isStretched

Response

Response Body

200 OK

Returns PageOfCluster of type(s) application/json

{
	"elements": [
		{
			"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, VSAN_REMOTE",
			"tags": [
				{
					"categoryId": "string",
					"categoryName": "string",
					"id": "string",
					"name": "string"
				}
			],
			"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"
						}
					]
				}
			]
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}

array of Cluster

elements Optional

The list of elements included in this page

PageMetadata

pageMetadata Optional

Pageable elements pagination metadata information

Errors

Error

400

Bad Request

Error

500

InternalServerError

Code Samples

cURL Command

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

vcf

Clusters Operations

post

Add Datastore To Cluster Introduced

put

Assign Tags To Existing Cluster Introduced

get

Assignable Tags To Cluster Introduced

post

Create Cluster

delete

Delete Cluster

get

Get Cluster

get

Get Cluster Datastores Introduced

get

Get Cluster Tag Manager URL

get

Get Clusters

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

get

Get Host Criteria

get

Get Host Criterion

get

Get Host Query Response

get

Get Tags Assigned To Cluster

get

Get Tags Assigned To Clusters Introduced

get

Get VDses

post

Post Datastore Query Introduced

post

Post Host Query

delete

Remove Datastore From Cluster Introduced

delete

Remove Tags From Existing Cluster Introduced

patch

Update Cluster

post

Validate Cluster Operations

post

Validate Clusters Operations

post

Validate vSAN Remote Datastore Introduced

Get Clusters

Request

URL

Query Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Clusters Operations

Was this page helpful?