VchaClusterHealth

VchaClusterHealth
VchaClusterHealth

The VchaClusterHealth class describes the overall VCHA Cluster health.

Health information include the last known runtime information about the VCHA Cluster along with health messages and any additional information applicable to the current VCHA Cluster health. If the cluster state is healthy, there will not be any health messages or additional information provided.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "runtimeInfo": {
        "_typeName": "string",
        "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"
        }
    ]
}
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.

healthMessages
Optional

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

additionalInformation
Optional

A collection of additional information regarding the health messages.