Skip to main content

health

Creates, updates, deletes, gets or lists a health resource.

Overview

Namehealth
TypeResource
Idgoogle.workloadmanager.health

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
checkTimestring (google-datetime)The time when the health check was performed.
componentsHealtharrayThe detailed condition reports of each component.
statestringOutput only. The health state of the workload. (HEALTH_STATE_UNSPECIFIED, HEALTHY, UNHEALTHY, CRITICAL, UNSUPPORTED)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, discoveredprofilesId, healthIdGet the health of a discovered workload profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
discoveredprofilesIdstring
healthIdstring
locationsIdstring
projectsIdstring

SELECT examples

Get the health of a discovered workload profile.

SELECT
checkTime,
componentsHealth,
state
FROM google.workloadmanager.health
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND discoveredprofilesId = '{{ discoveredprofilesId }}' -- required
AND healthId = '{{ healthId }}' -- required
;