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

Successful response

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 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. (pattern: a-z?)
checkIntervalSec	integer (int32)	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.
description	string	An optional description of this resource. Provide this property when you create the resource.
grpcHealthCheck	object	(id: GRPCHealthCheck)
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	Type of the resource. (default: compute#healthCheck)
logConfig	object	Configure logging on this health check. (id: HealthCheckLogConfig)
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	(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 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
unhealthyThreshold	integer (int32)	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

list

Successful response

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	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 than maxResults, 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] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, healthCheck		Returns the specified HealthCheck resource.
list	select	project, region	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of HealthCheck resources available to the specified project.
insert	insert	project, region	requestId	Creates a HealthCheck resource in the specified project using the data included in the request.
patch	update	project, region, healthCheck	requestId	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	project, region, healthCheck	requestId	Updates a HealthCheck resource in the specified project using the data included in the request.
delete	delete	project, region, 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
region	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified HealthCheck resource.

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

list

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 region = '{{ region }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

insert

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

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

Manifest

# Description fields are for documentation purposes
- name: health_checks
  props:
    - name: project
      value: string
      description: Required parameter for the health_checks resource.
    - name: region
      value: string
      description: Required parameter for the health_checks resource.
    - name: kind
      value: string
      description: >
        Type of the resource.
        
      default: compute#healthCheck
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in 3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: checkIntervalSec
      value: integer
      description: >
        How often (in seconds) to send a health check. The default value is 5 seconds.
        
    - name: timeoutSec
      value: integer
      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: unhealthyThreshold
      value: integer
      description: >
        A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
        
    - name: healthyThreshold
      value: integer
      description: >
        A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
        
    - name: type
      value: string
      description: >
        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.
        
      valid_values: ['GRPC', 'HTTP', 'HTTP2', 'HTTPS', 'INVALID', 'SSL', 'TCP']
    - name: tcpHealthCheck
      value: object
    - name: sslHealthCheck
      value: object
    - name: httpHealthCheck
      value: object
    - name: httpsHealthCheck
      value: object
    - name: http2HealthCheck
      value: object
    - name: grpcHealthCheck
      value: object
    - name: sourceRegions
      value: array
      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, 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. 
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: region
      value: string
      description: >
        [Output Only] Region where the health check resides. Not applicable to global health checks.
        
    - name: logConfig
      value: object
      description: >
        Configure logging on this health check.
        
    - name: requestId
      value: string

UPDATE examples

patch

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 google.compute.health_checks
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__checkIntervalSec = {{ checkIntervalSec }},
data__timeoutSec = {{ timeoutSec }},
data__unhealthyThreshold = {{ unhealthyThreshold }},
data__healthyThreshold = {{ healthyThreshold }},
data__type = '{{ type }}',
data__tcpHealthCheck = '{{ tcpHealthCheck }}',
data__sslHealthCheck = '{{ sslHealthCheck }}',
data__httpHealthCheck = '{{ httpHealthCheck }}',
data__httpsHealthCheck = '{{ httpsHealthCheck }}',
data__http2HealthCheck = '{{ http2HealthCheck }}',
data__grpcHealthCheck = '{{ grpcHealthCheck }}',
data__sourceRegions = '{{ sourceRegions }}',
data__selfLink = '{{ selfLink }}',
data__region = '{{ region }}',
data__logConfig = '{{ logConfig }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND healthCheck = '{{ healthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__checkIntervalSec = {{ checkIntervalSec }},
data__timeoutSec = {{ timeoutSec }},
data__unhealthyThreshold = {{ unhealthyThreshold }},
data__healthyThreshold = {{ healthyThreshold }},
data__type = '{{ type }}',
data__tcpHealthCheck = '{{ tcpHealthCheck }}',
data__sslHealthCheck = '{{ sslHealthCheck }}',
data__httpHealthCheck = '{{ httpHealthCheck }}',
data__httpsHealthCheck = '{{ httpsHealthCheck }}',
data__http2HealthCheck = '{{ http2HealthCheck }}',
data__grpcHealthCheck = '{{ grpcHealthCheck }}',
data__sourceRegions = '{{ sourceRegions }}',
data__selfLink = '{{ selfLink }}',
data__region = '{{ region }}',
data__logConfig = '{{ logConfig }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND healthCheck = '{{ healthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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 region = '{{ region }}' --required
AND healthCheck = '{{ healthCheck }}' --required
AND requestId = '{{ requestId }}';