SettingsStatusInfo

The StatusInfo structure contains fields that describe aggregated status of all checks performed on an entity.


Properties

check_statuses Required

List of CheckStatus for all checks performed.


status Required

The 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.

Possible values are: OKWARNINGTIMEOUTERRORRETRY

JSON Example

{
	"check_statuses": [
		{
			"check": {
				"check": "string",
				"description": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string"
				},
				"name": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string"
				}
			},
			"status": "OK"
		}
	],
	"status": "OK"
}

Feedback

Was this page helpful?