Failover Cluster Manager Get Vcha Cluster Health

Failover Cluster Manager Get Vcha Cluster Health

Returns last known health of the VCHA Cluster.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/FailoverClusterManager/{moId}/GetVchaClusterHealth
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case FailoverClusterManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VchaClusterHealth of type(s) application/json
"VchaClusterHealth Object"
object
runtimeInfo
Required

The VchaClusterRuntimeInfo class describes the runtime information of a VCHA Cluster.

This includes the last known state of the cluster and last known states of each node.

array of object
healthMessages
Optional

A collection of Messages describing the reason for a non-healthy Cluster.

array of object
additionalInformation
Optional

A collection of additional information regarding the health messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/FailoverClusterManager/{moId}/GetVchaClusterHealth