HealthChecks

For a list of methods for this resource, see the end of this page.

Resource representations

An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.

{
  "kind": "compute#healthCheck",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "checkIntervalSec": integer,
  "timeoutSec": integer,
  "unhealthyThreshold": integer,
  "healthyThreshold": integer,
  "type": string,
  "tcpHealthCheck": {
    "port": integer,
    "portName": string,
    "request": string,
    "response": string,
    "proxyHeader": string
  },
  "sslHealthCheck": {
    "port": integer,
    "portName": string,
    "request": string,
    "response": string,
    "proxyHeader": string
  },
  "httpHealthCheck": {
    "port": integer,
    "portName": string,
    "host": string,
    "requestPath": string,
    "proxyHeader": string
  },
  "httpsHealthCheck": {
    "port": integer,
    "portName": string,
    "host": string,
    "requestPath": string,
    "proxyHeader": string
  },
  "selfLink": string
}
Property name Value Description Notes
checkIntervalSec integer 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.
healthyThreshold integer A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
httpHealthCheck nested object
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.port integer 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 port_name are defined, port takes precedence.
httpHealthCheck.proxyHeader string Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
httpHealthCheck.requestPath string The request path of the HTTP health check request. The default value is /.
httpsHealthCheck nested object
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.port integer 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 port_name are defined, port takes precedence.
httpsHealthCheck.proxyHeader string Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
httpsHealthCheck.requestPath string The request path of the HTTPS health check request. The default value is /.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind string Type of the resource.
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.
sslHealthCheck nested object
sslHealthCheck.port integer 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 port_name are defined, port takes precedence.
sslHealthCheck.proxyHeader string Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
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.
tcpHealthCheck nested object
tcpHealthCheck.port integer 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 port_name are defined, port takes precedence.
tcpHealthCheck.proxyHeader string Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
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.
timeoutSec integer 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 or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
unhealthyThreshold integer A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Methods

delete
Deletes the specified HealthCheck resource.
get
Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.
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. This method supports patch semantics.
testIamPermissions
Returns permissions that a caller has on the specified resource.
update
Updates a HealthCheck resource in the specified project using the data included in the request.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine