Method: healthChecks.list

Retrieves the list of HealthCheck resources available to the specified project.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

number (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

filter

string

Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Request body

The request body must be empty.

Response body

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

Contains a list of HealthCheck resources.

JSON representation
{
  "id": string,
  "items": [
    {
      "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
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": {
      "key": string,
      "value": string
    }
  },
  "kind": string,
}
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object

A list of HealthCheck resources.

items[].id

string (fixed64 format)

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

items[].creationTimestamp

string

[Output Only] Creation timestamp in 3339 text format.

items[].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.

items[].description

string

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

items[].checkIntervalSec

number

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

items[].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.

items[].unhealthyThreshold

number

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

items[].healthyThreshold

number

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

items[].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.

items[].tcpHealthCheck

object

items[].tcpHealthCheck.port

number

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

items[].tcpHealthCheck.portName

string

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

items[].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.

items[].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.

items[].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.

items[].sslHealthCheck

object

items[].sslHealthCheck.port

number

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

items[].sslHealthCheck.portName

string

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

items[].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.

items[].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.

items[].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.

items[].httpHealthCheck

object

items[].httpHealthCheck.port

number

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

items[].httpHealthCheck.portName

string

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

items[].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.

items[].httpHealthCheck.requestPath

string

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

items[].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.

items[].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.

items[].httpsHealthCheck

object

items[].httpsHealthCheck.port

number

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

items[].httpsHealthCheck.portName

string

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

items[].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.

items[].httpsHealthCheck.requestPath

string

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

items[].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.

items[].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.

items[].udpHealthCheck

object

items[].udpHealthCheck.port

number

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

items[].udpHealthCheck.portName

string

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

items[].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.

items[].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.

items[].selfLink

string

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

items[].kind

string

Type of the resource.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

warning.message

string

[Output Only] A human-readable description of the warning code.

warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

warning.data[].value

string

[Output Only] A warning data value corresponding to the key.

kind

string

Type of 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.list

Send feedback about...

Compute Engine