Messages Health
Released in v6.7 DescriptionGet health messages.
Request
URLURL
https://{api_host}/rest/appliance/health/{item}/messages
Parameters
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
Response
Response
Response BodyResponse Body
200 OK returns
HealthMessagesResponseBody
of type application/json
List of the health messages
{
"value": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
]
}
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/health/{item}/messages
Errors
404
com.vmware.vapi.std.errors.not_found : Unknown health item | com.vmware.vapi.std.errors.error : Generic error
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.