SettingsClustersSoftwareCheckStatus

The Software.CheckStatus structure contains fields that describe a check result.


Properties

check Required

Information about this check.


check_issues Optional

List of Software.CheckIssues that the check reported. If not set, the service is still using the {#member issues}.


issues Required

The issues encountered while running this 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.

Possible values are: OKWARNINGTIMEOUTERRORRETRY

JSON Example

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

Feedback

Was this page helpful?