health_checks_aggregated

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

Overview

Name	health_checks_aggregated
Type	Resource
Id	google.compute.health_checks_aggregated

Fields

The following fields are returned by SELECT queries:

aggregated_list

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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
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.

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
project	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

aggregated_list

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,
healthyThreshold,
http2HealthCheck,
httpHealthCheck,
httpsHealthCheck,
kind,
logConfig,
region,
selfLink,
sourceRegions,
sslHealthCheck,
tcpHealthCheck,
timeoutSec,
type,
unhealthyThreshold
FROM google.compute.health_checks_aggregated
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 }}';