Failover Cluster Manager Get Vcha Cluster Health

Returns last known health of the VCHA Cluster.

Required privileges: System.Read

Request

URI

POST

https://{vcenter-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.

Session

Responses

200

Returns VchaClusterHealth of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "runtimeInfo": {
        "clusterState": "string",
        "nodeInfo": [
            {
                "_typeName": "string",
                "nodeState": "string",
                "nodeRole": "string",
                "nodeIp": "string"
            }
        ],
        "clusterMode": "string"
    },
    "healthMessages": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "additionalInformation": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

VchaClusterRuntimeInfo

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 LocalizableMessage

healthMessages

Optional

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

array of LocalizableMessage

additionalInformation

Optional