SettingsClustersSoftwareEntityCheckResult

The Software.EntityCheckResult structure contains fields that describe aggregated status of all checks performed on a specific entity.


Properties

check_statuses Required

List of Software.CheckStatus for all checks performed.


string
cluster Optional

If the entity type is CLUSTER then the cluster identifier for which the checks have been run. This field is optional and it is only relevant when the value of Software.EntityCheckResult.type is CLUSTER. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.


string
host Optional

If the entity type is HOST then the host identifier for which the checks have been run. This field is optional and it is only relevant when the value of Software.EntityCheckResult.type is HOST. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.


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


type Required

The Software.EntityCheckResult.EntityType enumerated type contains the entitites on which checks can be performed.
CLUSTER : Entity type Cluster
HOST : Entity type Host

Possible values are: CLUSTERHOST

JSON Example

{
	"check_statuses": [
		{
			"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"
		}
	],
	"status": "OK",
	"type": "CLUSTER"
}

Feedback

Was this page helpful?