[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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 Cluster
DescriptionGet a Cluster
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/clusters/{id}
Path Parameters
Path Parameters
string
id
Required
Cluster ID
Response
Response
Response BodyResponse Body
200 OK
Returns
Cluster
of type(s) application/json
{
"primaryDatastoreType": "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE"
}
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
Errors
Error
404
Cluster not found
Error
500
InternalServerError
Code Samples
cURL Command
curl https://sfo-vcf01.rainpole.io/v1/clusters/{id}
[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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
Add Datastore To Cluster
Introduced
put
Assign Tags To Existing Cluster
Introduced
get
Assignable Tags To Cluster
Introduced
post
delete
get
get
Get Cluster Datastores
Introduced
get
get
Get Datastore Criterion
Introduced
get
Get Datastore Query Response
Introduced
get
Get Datastores Criteria
Introduced
get
Get Tags Assigned To Clusters
Introduced
get
post
Post Datastore Query
Introduced
post
delete
Remove Datastore From Cluster
Introduced
delete
Remove Tags From Existing Cluster
Introduced
patch
post
Validate vSAN Remote Datastore
Introduced
