Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
httpHealthChecks

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

patch/projects/{project}/global/httpHealthChecks/{httpHealthCheck}

Path parameters

projectstring required

Project ID for this request.

httpHealthCheckstring required

Name of the HttpHealthCheck resource to patch.

Query parameters

requestIdstring

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

Request body

portinteger

The TCP port number for the HTTP health check request. The default value is80.

selfLinkstring

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

hoststring

The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

checkIntervalSecinteger

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

timeoutSecinteger

How long (in seconds) to wait before claiming failure. The default value is5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

idstring uint64

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

requestPathstring

The request path of the HTTP health check request. The default value is/. This field does not support query parameters. Must comply withRFC3986.

unhealthyThresholdinteger

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

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.

healthyThresholdinteger

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

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

descriptionstring

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

creationTimestampstring

[Output Only] Creation timestamp inRFC3339 text format.

Response

Successful response