Esx.Settings.CheckStatus

The Esx.Settings.CheckStatus schema contains properties that describe a check result.

JSON Example

{
    "check": {
        "check": "string",
        "name": "Vapi.Std.LocalizableMessage Object",
        "description": "Vapi.Std.LocalizableMessage Object"
    },
    "status": "string",
    "originator": "string",
    "errors": [
        {
            "description": "Vapi.Std.LocalizableMessage Object",
            "resolution": "Vapi.Std.LocalizableMessage Object"
        }
    ]
}

check

Required

Information about this check.

string

status

Required

The status of this check.

Possible values:

OK: The check indicates a success.
WARNING: The check indicates a warning.
TIMEOUT: The check did not return in a timely manner.
ERROR: The check indicates an error.
RETRY: The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

For more information see: Esx.Settings.Status.

string

originator

Optional

The service that performed the check. This field should allow easier triaging of health query errors.

Only set if there is an originator available for this check.

array of Esx.Settings.CheckError

errors

Optional

List of Esx.Settings.CheckError that the check reported.

If not set, the service is still using the {#member issues}. TODO

Property Of

Esx.Settings.StatusInfo