1. Operations
  2. appliance
  3. health

appliance health: messages

Get health messages. This operation was added in vSphere API 6.7

Request:

HTTP request

GET https://{server}/rest/appliance/health/{item}/messages

Path Parameters

Name Type Description
Required
item string ID of the data item.

Response:

HTTP Status Code: 200

Representation:

{
    "value": [
        {
            "id": "string",
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "resolution": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "time": "2015-01-01T22:13:05.651Z"
        },
        {
            "id": "string",
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "resolution": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "time": "2015-01-01T22:13:05.651Z"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value notification[] List of the health messages.
value[].id string The notification id. This attribute was added in vSphere API 6.7
value[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7

Optional. Only if the time information is available.
value[].message localizable_message The notification message. This attribute was added in vSphere API 6.7
value[].message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value[].message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value[].message.args string[] Arguments to be substituted into a message template.
value[].resolution localizable_message The resolution message, if any. This attribute was added in vSphere API 6.7

Optional. Only set for warnings and errors.
value[].resolution.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value[].resolution.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value[].resolution.args string[] Arguments to be substituted into a message template.

Errors:

HTTP Status Code Type Description
404 not_found Unknown health item
500 error Generic error