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, "tcpHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "sslHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "httpHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "httpsHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "http2HealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "grpcHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "grpcServiceName": string }, "sourceRegions": [ string ], "selfLink": string, "region": string, "logConfig": { "enable": boolean } } |
Fields | |
---|---|
kind |
Type of the resource. |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in 3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
checkIntervalSec |
How often (in seconds) to send a health check. The default value is 5 seconds. |
timeoutSec |
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for |
unhealthyThreshold |
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
healthyThreshold |
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
type |
Specifies the type of the healthCheck, either |
tcpHealthCheck |
|
tcpHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
tcpHealthCheck.portName |
Not supported. |
tcpHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
tcpHealthCheck.request |
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection. |
tcpHealthCheck.response |
Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp |
tcpHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
sslHealthCheck |
|
sslHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
sslHealthCheck.portName |
Not supported. |
sslHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
sslHealthCheck.request |
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake. |
sslHealthCheck.response |
Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp |
sslHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
httpHealthCheck |
|
httpHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
httpHealthCheck.portName |
Not supported. |
httpHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
httpHealthCheck.host |
The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest |
httpHealthCheck.requestPath |
The request path of the HTTP health check request. The default value is |
httpHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
httpHealthCheck.response |
Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http |
httpsHealthCheck |
|
httpsHealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
httpsHealthCheck.portName |
Not supported. |
httpsHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
httpsHealthCheck.host |
The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest |
httpsHealthCheck.requestPath |
The request path of the HTTPS health check request. The default value is |
httpsHealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
httpsHealthCheck.response |
Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http |
http2HealthCheck |
|
http2HealthCheck.port |
The TCP port number to which the health check prober sends packets. The default value is |
http2HealthCheck.portName |
Not supported. |
http2HealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
http2HealthCheck.host |
The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest |
http2HealthCheck.requestPath |
The request path of the HTTP/2 health check request. The default value is |
http2HealthCheck.proxyHeader |
Specifies the type of proxy header to append before sending data to the backend, either |
http2HealthCheck.response |
Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http |
grpcHealthCheck |
|
grpcHealthCheck.port |
The TCP port number to which the health check prober sends packets. Valid values are |
grpcHealthCheck.portName |
Not supported. |
grpcHealthCheck.portSpecification |
Specifies how a port is selected for health checking. Can be one of the following values: |
grpcHealthCheck.grpcServiceName |
The gRPC service name for the health check. This field is optional. The value of grpcServiceName has the following meanings by convention: |
sourceRegions[] |
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:
|
selfLink |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] Region where the health check resides. Not applicable to global health checks. |
logConfig |
Configure logging on this health check. |
logConfig.enable |
Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. |
Methods |
|
---|---|
|
Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. |
|
Deletes the specified HealthCheck resource. |
|
Returns the specified HealthCheck resource. |
|
Creates a HealthCheck resource in the specified project using the data included in the request. |
|
Retrieves the list of HealthCheck resources available to the specified project. |
|
Updates a HealthCheck resource in the specified project using the data included in the request. |
|
Updates a HealthCheck resource in the specified project using the data included in the request. |