Get

2 variables

49 variables

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

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 2 input parameters

Name	Format	Description
`project` Required	`STRING`	Project ID for this request
`healthCheck` Required	`STRING`	Name of the HealthCheck resource to return

= Parameter name
= Format

project STRING Required

Project ID for this request

healthCheck STRING Required

Name of the HealthCheck resource to return

Output

This building block provides 49 output parameters

Name	Format	Description
`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
`http2HealthCheck`	`OBJECT`
`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
`http2HealthCheck.port`	`INTEGER`	The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535
`http2HealthCheck.portName`	`STRING`	Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence
`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
`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
`http2HealthCheck.requestPath`	`STRING`	The request path of the HTTP/2 health check request. The default value is /
`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
`httpHealthCheck`	`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.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
`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
`httpHealthCheck.requestPath`	`STRING`	The request path of the HTTP health check request. The default value is /
`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
`httpsHealthCheck`	`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.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
`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
`httpsHealthCheck.requestPath`	`STRING`	The request path of the HTTPS health check request. The default value is /
`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
`id`	`INTEGER`	[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
`selfLink`	`STRING`	[Output Only] Server-defined URL for the resource
`sslHealthCheck`	`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.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
`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
`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`	`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.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
`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
`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`	`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
`unhealthyThreshold`	`INTEGER`	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2

= Parameter name
= Format

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

http2HealthCheck OBJECT

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

http2HealthCheck.port INTEGER

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

http2HealthCheck.portName STRING

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

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

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

http2HealthCheck.requestPath STRING

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

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

httpHealthCheck 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.portSpecification ENUMERATION

If not specified, HTTP health check follows behavior specified in port and portName fields

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

httpHealthCheck.requestPath STRING

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

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

httpsHealthCheck 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.portSpecification ENUMERATION

If not specified, HTTPS health check follows behavior specified in port and portName fields

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

httpsHealthCheck.requestPath STRING

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

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

id INTEGER

[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

selfLink STRING

[Output Only] Server-defined URL for the resource

sslHealthCheck 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.portSpecification ENUMERATION

If not specified, SSL health check follows behavior specified in port and portName fields

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

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 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.portSpecification ENUMERATION

If not specified, TCP health check follows behavior specified in port and portName fields

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

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

unhealthyThreshold INTEGER

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

Health Checks

Get

Authorization

Input

Output