Method: healthChecks.aggregatedList

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Name of the project scoping this request.

Query parameters

Parameters
maxResults

integer (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

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
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.
includeAllScopes

boolean

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "id": string,
  "items": [
    {
      "scopeName": string,
      "healthChecks": [
        {
          "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
          },
          "selfLink": string,
          "region": string,
          "logConfig": {
            "enable": boolean
          },
          "kind": string
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": 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 HealthChecksScopedList resources.
items[].scopeName

string

Name of the scope containing this set of HealthChecks.
items[].healthChecks[]

object

A list of HealthChecks contained in this scope.
items[].healthChecks[].id

string (fixed64 format)

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

string

[Output Only] Creation timestamp in 3339 text format.
items[].healthChecks[].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[].healthChecks[].description

string

An optional description of this resource. Provide this property when you create the resource.
items[].healthChecks[].checkIntervalSec

integer

How often (in seconds) to send a health check. The default value is 5 seconds.
items[].healthChecks[].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.
items[].healthChecks[].unhealthyThreshold

integer

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

integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
items[].healthChecks[].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.
items[].healthChecks[].tcpHealthCheck

object
items[].healthChecks[].tcpHealthCheck.port

integer

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
items[].healthChecks[].tcpHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
items[].healthChecks[].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.
items[].healthChecks[].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[].healthChecks[].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[].healthChecks[].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[].healthChecks[].sslHealthCheck

object
items[].healthChecks[].sslHealthCheck.port

integer

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
items[].healthChecks[].sslHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
items[].healthChecks[].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.
items[].healthChecks[].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[].healthChecks[].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[].healthChecks[].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[].healthChecks[].httpHealthCheck

object
items[].healthChecks[].httpHealthCheck.port

integer

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
items[].healthChecks[].httpHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
items[].healthChecks[].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.
items[].healthChecks[].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[].healthChecks[].httpHealthCheck.requestPath

string

The request path of the HTTP health check request. The default value is /.
items[].healthChecks[].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[].healthChecks[].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[].healthChecks[].httpsHealthCheck

object
items[].healthChecks[].httpsHealthCheck.port

integer

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
items[].healthChecks[].httpsHealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
items[].healthChecks[].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.
items[].healthChecks[].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[].healthChecks[].httpsHealthCheck.requestPath

string

The request path of the HTTPS health check request. The default value is /.
items[].healthChecks[].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[].healthChecks[].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[].healthChecks[].http2HealthCheck

object
items[].healthChecks[].http2HealthCheck.port

integer

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
items[].healthChecks[].http2HealthCheck.portName

string

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
items[].healthChecks[].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.
items[].healthChecks[].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.
items[].healthChecks[].http2HealthCheck.requestPath

string

The request path of the HTTP/2 health check request. The default value is /.
items[].healthChecks[].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.
items[].healthChecks[].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.
items[].healthChecks[].selfLink

string

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

string

[Output Only] Region where the health check resides. Not applicable to global health checks.
items[].healthChecks[].logConfig

object

Configure logging on this health check.
items[].healthChecks[].logConfig.enable

boolean

Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
items[].healthChecks[].kind

string

Type of the resource.
items[].warning

object

Informational warning which replaces the list of backend services when the list is empty.
items[].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.
items[].warning.message

string

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

object

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

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
items[].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).
items[].warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
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 Authentication Overview.

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

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.