Get Cluster
Get a cluster by its ID
Cluster ID
Ok
{
"id": "string",
"domain": {
"id": "string",
"name": "string",
"type": "string"
},
"name": "string",
"status": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, SKIPPED, DEACTIVATING, EXPANDING, SHRINKING, CREATING",
"hciMeshData": {
"name": "string",
"isHciMeshEnabled": false,
"remoteDatastore": "string",
"primaryDataStoreId": "string",
"vsanDataStores": [
"string"
],
"clientClusters": [
"string"
],
"remoteDatastoreInfos": [
{
"serverCluster": "string",
"remoteDatastore": "string"
}
],
"isServer": false,
"isClient": false,
"computeOnlyClient": false,
"numberOfClients": 0,
"numberOfServers": 0
},
"primaryDatastoreName": "string",
"primaryDatastoreType": "One among: VSAN, VSAN_ESA, VSAN_MAX, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"hosts": [
{
"id": "string",
"ipAddress": "string",
"fqdn": "string",
"vmNics": [
{
"name": "string",
"linkSpeedMB": 0,
"isInUse": false,
"isAutoNegotiateSupported": false,
"isActive": false
}
],
"azName": "string"
}
],
"isStretched": false,
"isDefault": false,
"failuresToTolerate": 0,
"vdsSpecs": [
{
"name": "string",
"isUsedByNsxt": false,
"nsxtSwitchConfig": {
"transportZones": [
{
"name": "string",
"transportType": "One among: VLAN, OVERLAY"
}
],
"hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
},
"portGroupSpecs": [
{
"name": "string",
"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL",
"activeUplinks": [
"string"
],
"standByUplinks": [
"string"
],
"teamingPolicy": "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased"
}
],
"niocBandwidthAllocationSpecs": [
{
"type": "string",
"niocTrafficResourceAllocation": {
"limit": 0,
"sharesInfo": {
"shares": 0,
"level": "One among: low, normal, high, custom"
},
"reservation": 0
}
}
],
"mtu": 0
}
],
"tags": [
{
"id": "string",
"name": "string",
"categoryId": "string",
"categoryName": "string"
}
],
"isImageBased": false,
"capacity": {
"cpu": {
"used": {
"value": "number",
"unit": "string"
},
"total": {
"value": "number",
"unit": "string"
},
"numberOfCores": 0,
"numberOfCPUPackages": 0
},
"memory": {
"used": {
"value": "number",
"unit": "string"
},
"total": {
"value": "number",
"unit": "string"
}
},
"storage": {
"used": {
"value": "number",
"unit": "string"
},
"total": {
"value": "number",
"unit": "string"
}
}
},
"vcenter": {
"id": "string",
"fqdn": "string",
"vcInstanceId": "string"
},
"managedObjectReferenceId": "string",
"vsanClusterMode": "string"
}ID of the cluster
Represents a domain reference
Name of the cluster
Status of the cluster
vSAN remote datastore mount related data for Cluster
Name of the primary datastore
Storage type of the primary datastore
List of hosts associated with the cluster
Status of the cluster if Stretched or not
Status of the cluster if default or not
Number of ESXi host failures to tolerate in the vSAN cluster. Applicable only for clusters with vSAN datastore
Distributed switches to added to the cluster
Deprecated, this list will always be returned empty
Is cluster managed by vSphere Lifecycle Manager Images - true if managed, false if managed by vSphere Lifecycle Manager Baselines
Represents a usage and capacity information of a Resource
Represents a vCenter reference
Managed Object Reference Id of this cluster in vCenter
vSAN cluster mode
Not Found
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
InternalServerError
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
curl -H 'Authorization: <value>' https://{api_host}/v1/clusters/{id}