[{"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
DescriptionGet the Clusters
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/clusters
Query Parameters
Query Parameters
boolean
isStretched
Optional
isStretched
Response
Response
Response BodyResponse 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
}
}
Errors
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
On This Page
Clusters Operations
post
Assign Tags To Cluster
Introduced
get
Attachable Tags To Cluster
Introduced
post
delete
post
Detach Tags From Cluster
Introduced
get
get
Get Cluster Tag Manager URL
Introduced
get
get
Get Tags Assigned To Cluster
Introduced
get
post
patch