Skip to main content

http_health_checks

Overview

Namehttp_health_checks
TypeResource
Idgoogle.compute.http_health_checks

Fields

NameDatatypeDescription
idstring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName 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.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
kindstring[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
hoststringThe 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.
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
unhealthyThresholdintegerA so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
healthyThresholdintegerA so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
selfLinkstring[Output Only] Server-defined URL for the resource.
timeoutSecintegerHow 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.
requestPathstringThe request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
portintegerThe TCP port number for the HTTP health check request. The default value is 80.
checkIntervalSecintegerHow often (in seconds) to send a health check. The default value is 5 seconds.

Methods

NameAccessible byRequired ParamsDescription
getSELECThttpHealthCheck, projectReturns the specified HttpHealthCheck resource.
listSELECTprojectRetrieves the list of HttpHealthCheck resources available to the specified project.
insertINSERTprojectCreates a HttpHealthCheck resource in the specified project using the data included in the request.
deleteDELETEhttpHealthCheck, projectDeletes the specified HttpHealthCheck resource.
patchEXEChttpHealthCheck, projectUpdates a HttpHealthCheck 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.
updateEXEChttpHealthCheck, projectUpdates a HttpHealthCheck resource in the specified project using the data included in the request.