Patch

Updates a HealthCheck resource in the specified project using the data included in the request

52 variables
32 variables

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules

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

Input

This building block consumes 52 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

healthCheck STRING Required

Name of the HealthCheck resource to patch

requestId STRING

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)

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

Output

This building block provides 32 output parameters

  = Parameter name
  = Format

clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

httpErrorStatusCode INTEGER

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found

id INTEGER

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

insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

name STRING

[Output Only] Name of the resource

operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

progress INTEGER

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

user STRING

[Output Only] User who requested the operation, for example: [email protected]

warnings[] OBJECT

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

warnings[].data[] OBJECT

warnings[].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)

warnings[].data[].value STRING

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

warnings[].message STRING

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

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations