Settings_Hosts_Software_CheckStatus
Settings_Hosts_Software_CheckStatus
The Software.CheckStatus structure contains fields that describe a check result.
JSON Example
{
"check": {
"check": "string",
"name": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string"
},
"status": "string",
"check_issues": [
{
"description": "Std_LocalizableMessage Object",
"resolution": "Std_LocalizableMessage Object"
}
]
}
check
Required
The Software.CheckInfo structure contains fields that describe a particular check.
status
Required
The Software.Status enumerated type defines the status result for a particular check.
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.
array of Settings_Hosts_Software_CheckIssue
check_issues
Optional
List of Software.CheckIssues that the check reported. If not set, the service is still using the {#member issues}.