health_checks

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

Overview

Name	health_checks
Type	Resource
Id	google.compute.health_checks

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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.
creationTimestamp	string	[Output Only] Creation timestamp in 3339 text format.
grpcHealthCheck	object
healthyThreshold	integer	A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
http2HealthCheck	object
httpHealthCheck	object
httpsHealthCheck	object
kind	string	Type of the resource.
logConfig	object	Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.
region	string	[Output Only] Region where the health check resides. Not applicable to global health checks.
selfLink	string	[Output Only] Server-defined URL for the resource.
sourceRegions	array	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.
sslHealthCheck	object
tcpHealthCheck	object
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.
type	string	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.
unhealthyThreshold	integer	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	healthCheck, project	Returns the specified HealthCheck resource.
list	SELECT	project	Retrieves the list of HealthCheck resources available to the specified project.
insert	INSERT	project	Creates a HealthCheck resource in the specified project using the data included in the request.
delete	DELETE	healthCheck, project	Deletes the specified HealthCheck resource.
patch	UPDATE	healthCheck, project	Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
update	REPLACE	healthCheck, project	Updates a HealthCheck resource in the specified project using the data included in the request.

SELECT examples

Retrieves the list of HealthCheck resources available to the specified project.

SELECT
id,
name,
description,
checkIntervalSec,
creationTimestamp,
grpcHealthCheck,
healthyThreshold,
http2HealthCheck,
httpHealthCheck,
httpsHealthCheck,
kind,
logConfig,
region,
selfLink,
sourceRegions,
sslHealthCheck,
tcpHealthCheck,
timeoutSec,
type,
unhealthyThreshold
FROM google.compute.health_checks
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new health_checks resource.

All Properties

/*+ create */
INSERT INTO google.compute.health_checks (
project,
name,
description,
checkIntervalSec,
timeoutSec,
unhealthyThreshold,
healthyThreshold,
type,
tcpHealthCheck,
sslHealthCheck,
httpHealthCheck,
httpsHealthCheck,
http2HealthCheck,
grpcHealthCheck,
sourceRegions,
region,
logConfig
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ checkIntervalSec }}',
'{{ timeoutSec }}',
'{{ unhealthyThreshold }}',
'{{ healthyThreshold }}',
'{{ type }}',
'{{ tcpHealthCheck }}',
'{{ sslHealthCheck }}',
'{{ httpHealthCheck }}',
'{{ httpsHealthCheck }}',
'{{ http2HealthCheck }}',
'{{ grpcHealthCheck }}',
'{{ sourceRegions }}',
'{{ region }}',
'{{ logConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: checkIntervalSec
      value: integer
    - name: timeoutSec
      value: integer
    - name: unhealthyThreshold
      value: integer
    - name: healthyThreshold
      value: integer
    - name: type
      value: string
    - name: tcpHealthCheck
      value:
        - name: port
          value: integer
        - name: portName
          value: string
        - name: portSpecification
          value: string
        - name: request
          value: string
        - name: response
          value: string
        - name: proxyHeader
          value: string
    - name: sslHealthCheck
      value:
        - name: port
          value: integer
        - name: portName
          value: string
        - name: portSpecification
          value: string
        - name: request
          value: string
        - name: response
          value: string
        - name: proxyHeader
          value: string
    - name: httpHealthCheck
      value:
        - name: port
          value: integer
        - name: portName
          value: string
        - name: portSpecification
          value: string
        - name: host
          value: string
        - name: requestPath
          value: string
        - name: proxyHeader
          value: string
        - name: response
          value: string
    - name: httpsHealthCheck
      value:
        - name: port
          value: integer
        - name: portName
          value: string
        - name: portSpecification
          value: string
        - name: host
          value: string
        - name: requestPath
          value: string
        - name: proxyHeader
          value: string
        - name: response
          value: string
    - name: http2HealthCheck
      value:
        - name: port
          value: integer
        - name: portName
          value: string
        - name: portSpecification
          value: string
        - name: host
          value: string
        - name: requestPath
          value: string
        - name: proxyHeader
          value: string
        - name: response
          value: string
    - name: grpcHealthCheck
      value:
        - name: port
          value: integer
        - name: portName
          value: string
        - name: portSpecification
          value: string
        - name: grpcServiceName
          value: string
    - name: sourceRegions
      value:
        - string
    - name: selfLink
      value: string
    - name: region
      value: string
    - name: logConfig
      value:
        - name: enable
          value: boolean

UPDATE example

Updates a health_checks resource.

/*+ update */
UPDATE google.compute.health_checks
SET 
name = '{{ name }}',
description = '{{ description }}',
checkIntervalSec = '{{ checkIntervalSec }}',
timeoutSec = '{{ timeoutSec }}',
unhealthyThreshold = '{{ unhealthyThreshold }}',
healthyThreshold = '{{ healthyThreshold }}',
type = '{{ type }}',
tcpHealthCheck = '{{ tcpHealthCheck }}',
sslHealthCheck = '{{ sslHealthCheck }}',
httpHealthCheck = '{{ httpHealthCheck }}',
httpsHealthCheck = '{{ httpsHealthCheck }}',
http2HealthCheck = '{{ http2HealthCheck }}',
grpcHealthCheck = '{{ grpcHealthCheck }}',
sourceRegions = '{{ sourceRegions }}',
region = '{{ region }}',
logConfig = '{{ logConfig }}'
WHERE 
healthCheck = '{{ healthCheck }}'
AND project = '{{ project }}';

REPLACE example

Replaces all fields in the specified health_checks resource.

/*+ update */
REPLACE google.compute.health_checks
SET 
name = '{{ name }}',
description = '{{ description }}',
checkIntervalSec = '{{ checkIntervalSec }}',
timeoutSec = '{{ timeoutSec }}',
unhealthyThreshold = '{{ unhealthyThreshold }}',
healthyThreshold = '{{ healthyThreshold }}',
type = '{{ type }}',
tcpHealthCheck = '{{ tcpHealthCheck }}',
sslHealthCheck = '{{ sslHealthCheck }}',
httpHealthCheck = '{{ httpHealthCheck }}',
httpsHealthCheck = '{{ httpsHealthCheck }}',
http2HealthCheck = '{{ http2HealthCheck }}',
grpcHealthCheck = '{{ grpcHealthCheck }}',
sourceRegions = '{{ sourceRegions }}',
region = '{{ region }}',
logConfig = '{{ logConfig }}'
WHERE 
healthCheck = '{{ healthCheck }}'
AND project = '{{ project }}';

DELETE example

Deletes the specified health_checks resource.

/*+ delete */
DELETE FROM google.compute.health_checks
WHERE healthCheck = '{{ healthCheck }}'
AND project = '{{ project }}';