REST Resource: healthChecks

• Resource: HealthCheck
  • JSON representation
• Methods

Resource: HealthCheck

Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

JSON representation

{ "id": string, "creationTimestamp": string, "name": string, "description": string, "checkIntervalSec": number, "timeoutSec": number, "unhealthyThreshold": number, "healthyThreshold": number, "type": enum, "tcpHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "sslHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "httpHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "httpsHealthCheck": { "port": number, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "http2HealthCheck": { "port": number, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "selfLink": string, "region": string, "kind": string }

Fields
id	string (fixed64 format) [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp	string [Output Only] Creation timestamp in 3339 text format.
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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description	string An optional description of this resource. Provide this property when you create the resource.
checkIntervalSec	number How often (in seconds) to send a health check. The default value is 5 seconds.
timeoutSec	number 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.
unhealthyThreshold	number A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
healthyThreshold	number A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
type	enum Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
tcpHealthCheck	object
tcpHealthCheck.port	number The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
tcpHealthCheck.portName	string Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
tcpHealthCheck.portSpecification	enum Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields.
tcpHealthCheck.request	string The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
tcpHealthCheck.response	string The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
tcpHealthCheck.proxyHeader	enum Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
sslHealthCheck	object
sslHealthCheck.port	number The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
sslHealthCheck.portName	string Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
sslHealthCheck.portSpecification	enum Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields.
sslHealthCheck.request	string The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
sslHealthCheck.response	string The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
sslHealthCheck.proxyHeader	enum Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
httpHealthCheck	object
httpHealthCheck.port	number The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
httpHealthCheck.portName	string Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
httpHealthCheck.portSpecification	enum Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields.
httpHealthCheck.host	string The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
httpHealthCheck.requestPath	string The request path of the HTTP health check request. The default value is /.
httpHealthCheck.proxyHeader	enum Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
httpHealthCheck.response	string The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
httpsHealthCheck	object
httpsHealthCheck.port	number The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
httpsHealthCheck.portName	string Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
httpsHealthCheck.portSpecification	enum Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields.
httpsHealthCheck.host	string The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
httpsHealthCheck.requestPath	string The request path of the HTTPS health check request. The default value is /.
httpsHealthCheck.proxyHeader	enum Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
httpsHealthCheck.response	string The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
http2HealthCheck	object
http2HealthCheck.port	number The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
http2HealthCheck.portName	string Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
http2HealthCheck.portSpecification	enum Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
http2HealthCheck.host	string The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
http2HealthCheck.requestPath	string The request path of the HTTP/2 health check request. The default value is /.
http2HealthCheck.proxyHeader	enum Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
http2HealthCheck.response	string The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
selfLink	string [Output Only] Server-defined URL for the resource.
region	string [Output Only] Region where the health check resides. Not applicable to global health checks.
kind	string Type of the resource.

Methods
aggregatedList	Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
delete	Deletes the specified HealthCheck resource.
get	Returns the specified HealthCheck resource.
insert	Creates a HealthCheck resource in the specified project using the data included in the request.
list	Retrieves the list of HealthCheck resources available to the specified project.
patch	Updates a HealthCheck resource in the specified project using the data included in the request.
update	Updates a HealthCheck resource in the specified project using the data included in the request.