Method: healthChecks.get

Returns the specified HealthCheck resource. acceleratorTypes.get a list of available health checks by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/healthChecks/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the HealthCheck resource to return.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "checkIntervalSec": number,
    "timeoutSec": number,
    "unhealthyThreshold": number,
    "healthyThreshold": number,
    "type": enum,
    "tcpHealthCheck": {
      "port": number,
      "portName": string,
      "request": string,
      "response": string,
      "proxyHeader": enum
    },
    "sslHealthCheck": {
      "port": number,
      "portName": string,
      "request": string,
      "response": string,
      "proxyHeader": enum
    },
    "httpHealthCheck": {
      "port": number,
      "portName": string,
      "host": string,
      "requestPath": string,
      "proxyHeader": enum,
      "response": string
    },
    "httpsHealthCheck": {
      "port": number,
      "portName": string,
      "host": string,
      "requestPath": string,
      "proxyHeader": enum,
      "response": string
    },
    "udpHealthCheck": {
      "port": number,
      "portName": string,
      "request": string,
      "response": string
    },
    "selfLink": string,
    "kind": string
  },
}
Fields
resource

object

resource.id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

resource.creationTimestamp

string

[Output Only] Creation timestamp in 3339 text format.

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.

resource.description

string

An optional description of this resource. Provide this property when you create the resource.

resource.checkIntervalSec

number

How often (in seconds) to send a health check. The default value is 5 seconds.

resource.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.

resource.unhealthyThreshold

number

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

resource.healthyThreshold

number

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

resource.type

enum

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.

resource.tcpHealthCheck

object

resource.tcpHealthCheck.port

number

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

resource.tcpHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

resource.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.

resource.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.

resource.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.

resource.sslHealthCheck

object

resource.sslHealthCheck.port

number

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

resource.sslHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

resource.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.

resource.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.

resource.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.

resource.httpHealthCheck

object

resource.httpHealthCheck.port

number

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

resource.httpHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

resource.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.

resource.httpHealthCheck.requestPath

string

The request path of the HTTP health check request. The default value is /.

resource.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.

resource.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.

resource.httpsHealthCheck

object

resource.httpsHealthCheck.port

number

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

resource.httpsHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

resource.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.

resource.httpsHealthCheck.requestPath

string

The request path of the HTTPS health check request. The default value is /.

resource.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.

resource.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.

resource.udpHealthCheck

object

resource.udpHealthCheck.port

number

The UDP port number for the health check request. Valid values are 1 through 65535.

resource.udpHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

resource.udpHealthCheck.request

string

Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.

resource.udpHealthCheck.response

string

The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.kind

string

Type of the resource.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.healthChecks.get

Send feedback about...

Compute Engine