Skip to main content

region_health_checks

Overview

Nameregion_health_checks
TypeResource
Idgoogle.compute.region_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. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
kindstringType of the resource.
typestringSpecifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
healthyThresholdintegerA so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
httpHealthCheckobject
grpcHealthCheckobject
regionstring[Output Only] Region where the health check resides. Not applicable to global health checks.
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.
http2HealthCheckobject
httpsHealthCheckobject
checkIntervalSecintegerHow often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestampstring[Output Only] Creation timestamp in 3339 text format.
tcpHealthCheckobject
sslHealthCheckobject
selfLinkstring[Output Only] Server-defined URL for the resource.
logConfigobjectConfiguration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.
unhealthyThresholdintegerA so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Methods

NameAccessible byRequired ParamsDescription
getSELECThealthCheck, project, regionReturns the specified HealthCheck resource.
listSELECTproject, regionRetrieves the list of HealthCheck resources available to the specified project.
insertINSERTproject, regionCreates a HealthCheck resource in the specified project using the data included in the request.
deleteDELETEhealthCheck, project, regionDeletes the specified HealthCheck resource.
patchEXEChealthCheck, project, regionUpdates 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.
updateEXEChealthCheck, project, regionUpdates a HealthCheck resource in the specified project using the data included in the request.