health_checks

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

Overview

Name	`health_checks`
Type	Resource
Id	`google.compute.health_checks`

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	[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 withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`checkIntervalSec`	`integer (int32)`	How often (in seconds) to send a health check. The default value is 5 seconds.
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp in3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`grpcHealthCheck`	`object`	(id: GRPCHealthCheck)
`grpcTlsHealthCheck`	`object`	(id: GRPCTLSHealthCheck)
`healthyThreshold`	`integer (int32)`	A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
`http2HealthCheck`	`object`	(id: HTTP2HealthCheck)
`httpHealthCheck`	`object`	(id: HTTPHealthCheck)
`httpsHealthCheck`	`object`	(id: HTTPSHealthCheck)
`kind`	`string`	Output only. Type of the resource. (default: compute#healthCheck)
`logConfig`	`object`	Configure logging on this health check. (id: HealthCheckLogConfig)
`region`	`string`	Output only. [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, GRPC, and GRPC_WITH_TLS 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`	(id: SSLHealthCheck)
`tcpHealthCheck`	`object`	(id: TCPHealthCheck)
`timeoutSec`	`integer (int32)`	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, GRPC or GRPC_WITH_TLS. Exactly one of the protocol-specific health check fields must be specified, which must match type field. (GRPC, GRPC_WITH_TLS, HTTP, HTTP2, HTTPS, INVALID, SSL, TCP)
`unhealthyThreshold`	`integer (int32)`	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of HealthCheck resources.
`kind`	`string`	Output only. Type of resource. (default: compute#healthCheckList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Name	Datatype	Description
`id`	`string (uint64)`	[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 withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`checkIntervalSec`	`integer (int32)`	How often (in seconds) to send a health check. The default value is 5 seconds.
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp in3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`grpcHealthCheck`	`object`	(id: GRPCHealthCheck)
`grpcTlsHealthCheck`	`object`	(id: GRPCTLSHealthCheck)
`healthyThreshold`	`integer (int32)`	A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
`http2HealthCheck`	`object`	(id: HTTP2HealthCheck)
`httpHealthCheck`	`object`	(id: HTTPHealthCheck)
`httpsHealthCheck`	`object`	(id: HTTPSHealthCheck)
`kind`	`string`	Output only. Type of the resource. (default: compute#healthCheck)
`logConfig`	`object`	Configure logging on this health check. (id: HealthCheckLogConfig)
`region`	`string`	Output only. [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, GRPC, and GRPC_WITH_TLS 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`	(id: SSLHealthCheck)
`tcpHealthCheck`	`object`	(id: TCPHealthCheck)
`timeoutSec`	`integer (int32)`	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, GRPC or GRPC_WITH_TLS. Exactly one of the protocol-specific health check fields must be specified, which must match type field. (GRPC, GRPC_WITH_TLS, HTTP, HTTP2, HTTPS, INVALID, SSL, TCP)
`unhealthyThreshold`	`integer (int32)`	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `healthCheck`		Returns the specified HealthCheck resource.
`list`	`select`	`project`	`filter`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`	Retrieves the list of HealthCheck resources available to the specified project.
`aggregated_list`	`select`	`project`	`filter`, `includeAllScopes`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`, `serviceProjectNumber`	Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`	`requestId`	Creates a HealthCheck resource in the specified project using the data included in the request.
`patch`	`update`	`project`, `healthCheck`	`requestId`	Updates a HealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
`update`	`replace`	`project`, `healthCheck`	`requestId`	Updates a HealthCheck resource in the specified project using the data included in the request.
`delete`	`delete`	`project`, `healthCheck`	`requestId`	Deletes the specified HealthCheck resource.

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.

Name	Datatype	Description
`healthCheck`	`string`
`project`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`

`SELECT` examples

get
list
aggregated_list

Returns the specified HealthCheck resource.

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

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

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.health_checks
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

Retrieves the list of all HealthCheck resources, regional and global,
available to the specified project.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
checkIntervalSec,
creationTimestamp,
description,
grpcHealthCheck,
grpcTlsHealthCheck,
healthyThreshold,
http2HealthCheck,
httpHealthCheck,
httpsHealthCheck,
kind,
logConfig,
region,
selfLink,
sourceRegions,
sslHealthCheck,
tcpHealthCheck,
timeoutSec,
type,
unhealthyThreshold
FROM google.compute.health_checks
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
;

`INSERT` examples

insert
Manifest

Creates a HealthCheck resource in the specified project using the data
included in the request.

INSERT INTO google.compute.health_checks (
data__checkIntervalSec,
data__description,
data__grpcHealthCheck,
data__grpcTlsHealthCheck,
data__healthyThreshold,
data__http2HealthCheck,
data__httpHealthCheck,
data__httpsHealthCheck,
data__id,
data__logConfig,
data__name,
data__selfLink,
data__sourceRegions,
data__sslHealthCheck,
data__tcpHealthCheck,
data__timeoutSec,
data__type,
data__unhealthyThreshold,
project,
requestId
)
SELECT 
{{ checkIntervalSec }},
'{{ description }}',
'{{ grpcHealthCheck }}',
'{{ grpcTlsHealthCheck }}',
{{ healthyThreshold }},
'{{ http2HealthCheck }}',
'{{ httpHealthCheck }}',
'{{ httpsHealthCheck }}',
'{{ id }}',
'{{ logConfig }}',
'{{ name }}',
'{{ selfLink }}',
'{{ sourceRegions }}',
'{{ sslHealthCheck }}',
'{{ tcpHealthCheck }}',
{{ timeoutSec }},
'{{ type }}',
{{ unhealthyThreshold }},
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: health_checks
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the health_checks resource.
  - name: checkIntervalSec
    value: {{ checkIntervalSec }}
    description: |
      How often (in seconds) to send a health check. The default value is 5
      seconds.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: grpcHealthCheck
    value:
      grpcServiceName: "{{ grpcServiceName }}"
      port: {{ port }}
      portName: "{{ portName }}"
      portSpecification: "{{ portSpecification }}"
  - name: grpcTlsHealthCheck
    value:
      grpcServiceName: "{{ grpcServiceName }}"
      port: {{ port }}
      portSpecification: "{{ portSpecification }}"
  - name: healthyThreshold
    value: {{ healthyThreshold }}
    description: |
      A so-far unhealthy instance will be marked healthy after this
      many consecutive successes. The default value is 2.
  - name: http2HealthCheck
    value:
      host: "{{ host }}"
      port: {{ port }}
      portName: "{{ portName }}"
      portSpecification: "{{ portSpecification }}"
      proxyHeader: "{{ proxyHeader }}"
      requestPath: "{{ requestPath }}"
      response: "{{ response }}"
  - name: httpHealthCheck
    value:
      host: "{{ host }}"
      port: {{ port }}
      portName: "{{ portName }}"
      portSpecification: "{{ portSpecification }}"
      proxyHeader: "{{ proxyHeader }}"
      requestPath: "{{ requestPath }}"
      response: "{{ response }}"
  - name: httpsHealthCheck
    value:
      host: "{{ host }}"
      port: {{ port }}
      portName: "{{ portName }}"
      portSpecification: "{{ portSpecification }}"
      proxyHeader: "{{ proxyHeader }}"
      requestPath: "{{ requestPath }}"
      response: "{{ response }}"
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: logConfig
    description: |
      Configure logging on this health check.
    value:
      enable: {{ enable }}
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: sourceRegions
    value:
      - "{{ sourceRegions }}"
    description: |
      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, GRPC, and GRPC_WITH_TLS 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.
  - name: sslHealthCheck
    value:
      port: {{ port }}
      portName: "{{ portName }}"
      portSpecification: "{{ portSpecification }}"
      proxyHeader: "{{ proxyHeader }}"
      request: "{{ request }}"
      response: "{{ response }}"
  - name: tcpHealthCheck
    value:
      port: {{ port }}
      portName: "{{ portName }}"
      portSpecification: "{{ portSpecification }}"
      proxyHeader: "{{ proxyHeader }}"
      request: "{{ request }}"
      response: "{{ response }}"
  - name: timeoutSec
    value: {{ timeoutSec }}
    description: |
      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.
  - name: type
    value: "{{ type }}"
    description: |
      Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS.
      Exactly one of the protocol-specific health check fields must be specified,
      which must match type field.
    valid_values: ['GRPC', 'GRPC_WITH_TLS', 'HTTP', 'HTTP2', 'HTTPS', 'INVALID', 'SSL', 'TCP']
  - name: unhealthyThreshold
    value: {{ unhealthyThreshold }}
    description: |
      A so-far healthy instance will be marked unhealthy after this many
      consecutive failures. The default value is 2.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates a HealthCheck resource in the specified project using the data
included in the request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

UPDATE google.compute.health_checks
SET 
data__checkIntervalSec = {{ checkIntervalSec }},
data__description = '{{ description }}',
data__grpcHealthCheck = '{{ grpcHealthCheck }}',
data__grpcTlsHealthCheck = '{{ grpcTlsHealthCheck }}',
data__healthyThreshold = {{ healthyThreshold }},
data__http2HealthCheck = '{{ http2HealthCheck }}',
data__httpHealthCheck = '{{ httpHealthCheck }}',
data__httpsHealthCheck = '{{ httpsHealthCheck }}',
data__id = '{{ id }}',
data__logConfig = '{{ logConfig }}',
data__name = '{{ name }}',
data__selfLink = '{{ selfLink }}',
data__sourceRegions = '{{ sourceRegions }}',
data__sslHealthCheck = '{{ sslHealthCheck }}',
data__tcpHealthCheck = '{{ tcpHealthCheck }}',
data__timeoutSec = {{ timeoutSec }},
data__type = '{{ type }}',
data__unhealthyThreshold = {{ unhealthyThreshold }}
WHERE 
project = '{{ project }}' --required
AND healthCheck = '{{ healthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`REPLACE` examples

update

Updates a HealthCheck resource in the specified project using the data
included in the request.

REPLACE google.compute.health_checks
SET 
data__checkIntervalSec = {{ checkIntervalSec }},
data__description = '{{ description }}',
data__grpcHealthCheck = '{{ grpcHealthCheck }}',
data__grpcTlsHealthCheck = '{{ grpcTlsHealthCheck }}',
data__healthyThreshold = {{ healthyThreshold }},
data__http2HealthCheck = '{{ http2HealthCheck }}',
data__httpHealthCheck = '{{ httpHealthCheck }}',
data__httpsHealthCheck = '{{ httpsHealthCheck }}',
data__id = '{{ id }}',
data__logConfig = '{{ logConfig }}',
data__name = '{{ name }}',
data__selfLink = '{{ selfLink }}',
data__sourceRegions = '{{ sourceRegions }}',
data__sslHealthCheck = '{{ sslHealthCheck }}',
data__tcpHealthCheck = '{{ tcpHealthCheck }}',
data__timeoutSec = {{ timeoutSec }},
data__type = '{{ type }}',
data__unhealthyThreshold = {{ unhealthyThreshold }}
WHERE 
project = '{{ project }}' --required
AND healthCheck = '{{ healthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified HealthCheck resource.

DELETE FROM google.compute.health_checks
WHERE project = '{{ project }}' --required
AND healthCheck = '{{ healthCheck }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​