This API has a deprecated equivalent from v7.0U1.
Messages Health
Get health messages.
Request
URLURL
https://{api_host}/api/appliance/health/{item}/messages
Path Parameters
Path Parameters
string
item
Required
ID of the data item The parameter must be an identifier for the resource type: com.vmware.appliance.health.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
Notification
of type application/json
List of the health messages
[
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
]
string
id
Required
The notification id.
resolution
Optional
The resolution message, if any. Only set for warnings and errors.
string
time
Optional
The time the notification was raised/found. Only if the time information is available.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetItemHealthMessages -Item "MyItem"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/health/{item}/messages
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/health/{item}/messages
x-vmw-doc-operation: messages
Availability
Added in 7.0U2
