[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get Clusters

Description

Get the Clusters

Request

Request

URL

URL


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

Query Parameters

Query Parameters

boolean
isStretched Optional

isStretched


Response

Response

Response Body

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 Optional

Pageable elements pagination metadata information

Errors

Errors

400

Bad Request


500

InternalServerError

Code Samples

Code Samples

cURL Command

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


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?