REST Resource: projects.locations.discoveredprofiles.health

Resource: WorkloadProfileHealth

WorkloadProfileHealth contains the detailed health check of workload.

JSON representation
{
  "checkTime": string,
  "state": enum (HealthState),
  "componentsHealth": [
    {
      object (ComponentHealth)
    }
  ]
}
Fields
checkTime

string (Timestamp format)

The time when the health check was performed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state

enum (HealthState)

Output only. The health state of the workload.

componentsHealth[]

object (ComponentHealth)

The detailed condition reports of each component.

HealthState

The health state of a workload.

Enums
HEALTH_STATE_UNSPECIFIED Unspecified.
HEALTHY Healthy workload.
UNHEALTHY Unhealthy workload.
CRITICAL Has critical issues.
UNSUPPORTED Unsupported.

ComponentHealth

HealthCondition contains the detailed health check of each component.

JSON representation
{
  "state": enum (HealthState),
  "componentHealthChecks": [
    {
      object (HealthCheck)
    }
  ],
  "componentHealthType": enum (Type),
  "subComponentsHealth": [
    {
      object (ComponentHealth)
    }
  ],
  "component": string
}
Fields
state

enum (HealthState)

Output only. The health state of the component.

componentHealthChecks[]

object (HealthCheck)

The detailed health checks of the component.

componentHealthType

enum (Type)

Output only. The type of the component health.

subComponentsHealth[]

object (ComponentHealth)

Sub component health.

component

string

The component of a workload.

HealthCheck

HealthCheck contains the detailed health check of a component based on asource.

JSON representation
{
  "source": string,
  "state": enum (State),
  "message": string,
  "resource": {
    object (CloudResource)
  },
  "metric": string
}
Fields
source

string

Output only. The source of the health check.

state

enum (State)

Output only. The state of the health check.

message

string

Output only. The message of the health check.

resource

object (CloudResource)

Output only. The resource the check performs on.

metric

string

Output only. The health check source metric name.

State

The state of health check.

Enums
STATE_UNSPECIFIED Unspecified
PASSED passed
FAILED failed
DEGRADED degraded
SKIPPED skipped
UNSUPPORTED unsupported

Type

The state of health check.

Enums
TYPE_UNSPECIFIED Unspecified
TYPE_REQUIRED required
TYPE_OPTIONAL optional
TYPE_SPECIAL special

Methods

get

Get the health of a discovered workload profile.