List

Retrieves the list of HealthCheck resources available to the specified project

5 variables
60 variables

Retrieves the list of HealthCheck resources available to the specified project

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

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)

maxResults INTEGER

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)

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

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

Output

This building block provides 60 output parameters

  = Parameter name
  = Format

id STRING

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

items[] OBJECT

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

items[].checkIntervalSec INTEGER

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

items[].creationTimestamp STRING

[Output Only] Creation timestamp in 3339 text format

items[].description STRING

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

items[].healthyThreshold INTEGER

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

items[].http2HealthCheck OBJECT

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

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

items[].http2HealthCheck.portName STRING

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

items[].http2HealthCheck.portSpecification ENUMERATION

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[].http2HealthCheck.proxyHeader ENUMERATION

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE

items[].http2HealthCheck.requestPath STRING

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

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

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.port INTEGER

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 port_name are defined, port takes precedence

items[].httpHealthCheck.portSpecification ENUMERATION

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[].httpHealthCheck.proxyHeader ENUMERATION

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.requestPath STRING

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

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.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.port INTEGER

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 port_name are defined, port takes precedence

items[].httpsHealthCheck.portSpecification ENUMERATION

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[].httpsHealthCheck.proxyHeader ENUMERATION

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.requestPath STRING

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

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[].id INTEGER

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

items[].kind STRING

Type of the resource

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[].selfLink STRING

[Output Only] Server-defined URL for the resource

items[].sslHealthCheck OBJECT

items[].sslHealthCheck.port INTEGER

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 port_name are defined, port takes precedence

items[].sslHealthCheck.portSpecification ENUMERATION

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[].sslHealthCheck.proxyHeader ENUMERATION

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.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[].tcpHealthCheck OBJECT

items[].tcpHealthCheck.port INTEGER

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 port_name are defined, port takes precedence

items[].tcpHealthCheck.portSpecification ENUMERATION

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[].tcpHealthCheck.proxyHeader ENUMERATION

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE

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[].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[].type ENUMERATION

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[].unhealthyThreshold INTEGER

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

kind STRING

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

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[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.data[] OBJECT

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

warning.message STRING

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