Health_StatusInfo

Represents the aggregated status of a single entity. Note: This structure is restricted for VMware internal use only.

JSON Example

{
    "status": "string",
    "wait_duration": 0,
    "check_statuses": [
        {
            "info": {
                "check": "string",
                "name": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "localized": "string"
                },
                "description": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "localized": "string"
                }
            },
            "status": "Health_Status Object",
            "wait_duration": 0,
            "issues": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "localized": "string"
                }
            ]
        }
    ]
}

Health_Status

status

Required

Represents system status of a particular check. Note: This enumeration is restricted for VMware internal use only.
OK : The check is successful, i.e. the entity can transition to the target state.
WAIT : The check is still running. Check the {#member CheckStatus.waitDuration} to see the expected wait time.
NOT_OK : The check has failed, i.e. the entity is not ready to transition to the target state. Any reported issues in the {#member CheckStatus.issues} field need to resolved.

integer As int64

wait_duration

Optional

If status value is WAIT the duration in miliseconds to wait before issuing status check again. This field is optional and it is only relevant when the value of StatusInfo.status is WAIT.

array of Health_CheckStatus

check_statuses

Required

List of CheckStatus objects for all Checks, which were executed and did NOT return an OK Status.