REST Resource: regionHealthChecks

Resource: HealthCheck

Represents a health check resource.

Google Compute Engine has two health check resources:

These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG).

Load balancing

Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide.

Autohealing in MIGs

The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing.

For more information, see Health checks overview.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "checkIntervalSec": integer,
  "timeoutSec": integer,
  "unhealthyThreshold": integer,
  "healthyThreshold": integer,
  "type": enum (HealthCheckType),
  "tcpHealthCheck": {
    object (TCPHealthCheck)
  },
  "sslHealthCheck": {
    object (SSLHealthCheck)
  },
  "httpHealthCheck": {
    object (HTTPHealthCheck)
  },
  "httpsHealthCheck": {
    object (HTTPSHealthCheck)
  },
  "http2HealthCheck": {
    object (HTTP2HealthCheck)
  },
  "grpcHealthCheck": {
    object (GRPCHealthCheck)
  },
  "sourceRegions": [
    string
  ],
  "selfLink": string,
  "region": string,
  "logConfig": {
    object (LogConfig)
  }
}
Fields
kind

string

Type of the resource.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in 3339 text format.
name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
description

string

An optional description of this resource. Provide this property when you create the resource.
checkIntervalSec

integer

How often (in seconds) to send a health check. The default value is 5 seconds.
timeoutSec

integer

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for

timeoutSec

to have greater value than

checkIntervalSec

.
unhealthyThreshold

integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
healthyThreshold

integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
type

enum (HealthCheckType)

Specifies the type of the healthCheck, either

TCP

,

SSL

,

HTTP

,

HTTPS

,

HTTP2

or

GRPC

. Exactly one of the protocol-specific health check fields must be specified, which must match

type

field.
tcpHealthCheck

object (TCPHealthCheck)
sslHealthCheck

object (SSLHealthCheck)
httpHealthCheck

object (HTTPHealthCheck)
httpsHealthCheck

object (HTTPSHealthCheck)
http2HealthCheck

object (HTTP2HealthCheck)
grpcHealthCheck

object (GRPCHealthCheck)
sourceRegions[]

string

The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check:

  • SSL, HTTP2, and GRPC protocols are not supported.
  • The TCP

    request

    field is not supported.

  • The

    proxyHeader

    field for HTTP, HTTPS, and TCP is not supported.

  • The

    checkIntervalSec

    field must be at least 30.

  • The health check cannot be used with BackendService nor with managed instance group auto-healing.
region

string

[Output Only] Region where the health check resides. Not applicable to global health checks.
logConfig

object (LogConfig)

Configure logging on this health check.

Methods

delete

 The method compute.v1.RegionHealthChecksService.Delete is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.RegionHealthChecksService.Get is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.RegionHealthChecksService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.RegionHealthChecksService.List is not available in this (s3nsapis.fr) universe.

patch

 The method compute.v1.RegionHealthChecksService.Patch is not available in this (s3nsapis.fr) universe.

update

 The method compute.v1.RegionHealthChecksService.Update is not available in this (s3nsapis.fr) universe.