API Guide

Table 15. HTTP response code
Code Description or response object
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 112.
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 96.
Get cluster health
Description: Gets the health (DRS and vSAN cluster health) of the given cluster ID. The health data is used for assessing the
firmware update.
The data that is displayed here is real-time health information.
Command or URL: /Services/ConsoleService/Clusters/{cluster_id}/Details
Method: GET
Authorization: Bearer authentication
Parameters:
Table 16. 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 44.
N/A Path String
Console management 47