Get Cluster
Get a cluster by its ID
Cluster ID
Ok
{
"capacity": {
"cpu": {
"total": {
"unit": "string",
"value": "number"
},
"used": {
"unit": "string",
"value": "number"
}
},
"memory": {
"total": {
"unit": "string",
"value": "number"
},
"used": {
"unit": "string",
"value": "number"
}
},
"storage": {
"total": {
"unit": "string",
"value": "number"
},
"used": {
"unit": "string",
"value": "number"
}
}
},
"hosts": [
{
"azName": "string",
"fqdn": "string",
"id": "string",
"ipAddress": "string",
"vmNics": [
{
"isActive": false,
"isAutoNegotiateSupported": false,
"isInUse": false,
"linkSpeedMB": 0,
"name": "string"
}
]
}
],
"id": "string",
"isDefault": false,
"isImageBased": false,
"isStretched": false,
"name": "string",
"primaryDatastoreName": "string",
"primaryDatastoreType": "One among: VSAN, VSAN_ESA, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
"tags": [
{
"categoryId": "string",
"categoryName": "string",
"id": "string",
"name": "string"
}
],
"vdsSpecs": [
{
"isUsedByNsxt": false,
"nsxtSwitchConfig": {
"transportZones": [
{
"name": "string",
"transportType": "One among: VLAN, OVERLAY"
}
],
"hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
},
"mtu": 0,
"name": "string",
"niocBandwidthAllocationSpecs": [
{
"niocTrafficResourceAllocation": {
"limit": 0,
"reservation": 0,
"sharesInfo": {
"level": "One among: low, normal, high, custom",
"shares": 0
}
},
"type": "string"
}
],
"portGroupSpecs": [
{
"activeUplinks": [
"string"
],
"standByUplinks": [
"string"
],
"teamingPolicy": "One among: loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
"name": "string",
"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT"
}
]
}
]
}ID of the cluster
Status of the cluster if default or not
Is vSphere cluster managed by vSphere Lifecycle Manager - true for managed, false for not managed
Status of the cluster if Stretched or not
Name of the cluster
Name of the primary datastore
Storage type of the primary datastore
Cluster not found
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
InternalServerError
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message