API Guide

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 9. 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 10. HTTP response code

Code Description

200 OK

400 Operational context is 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:

{

"clusterId": "{cluster ID}",

"drsState": "{DRS status}",

"vsanObjectHealth": "{vSAN object health status}"

}

For more information, see Response body on page 39.

Console management