API Guide

Get cluster details
Description: Gets the cluster details of the given cluster ID. You can view all the hosts belong to the cluster. The vSAN and
vSphere cluster details are displayed.
Command or URL: /Services/ConsoleService/Clusters/{cluster-id}
Method: GET
Authorization: Bearer authentication
Parameters:
Table 7. Parameters
Parameter Value Description Default value Parameter
type
Data type
id (required) Resource ID. Use the cluster ID received from
the Get vCenter tree view of datacenter
API. For more information, see Get vCenter
tree view of data center on page 11.
N/A Path String
vCenter privileges required: None
HTTP response code:
Table 8. HTTP response code
Code Description
200 OK
400 Operational context not set
401 Authorization failure
404 Resource not found
429 Too many requests
500 Internal Server error / timeout
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 47.
Example response:
{
"id": "{Cluster ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/ConsoleService/Clusters/
{cluster ID}",
"objectType": "Cluster",
"name": "{Cluster name}",
"consoleID": {Console ID},
"clusterType": "{Cluster Type (vSAN or vSphere)}",
"hosts": [
{
"id": "{Host ID}",
"href": "",
"objectType": "Host",
"hostip": "{host IP}",
"hostName": "{Hostname}",
"managementIP": "{iDRAC IP}",
"serviceTag": "{Service Tag}",
"model": "{Server model name}",
"systemId": "{System ID}"
}
]
}
For more information, see Response body on page 39.
14
Console management