An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.
For a list of methods for this resource, see the end of this page.
Resource representations
A HttpHealthCheck resource.
{
"kind": "compute#httpHealthCheck",
"selfLink": string,
"id": unsigned long,
"creationTimestamp": string,
"name": string,
"description": string,
"host": string,
"requestPath": string,
"port": integer,
"checkIntervalSec": integer,
"timeoutSec": integer,
"unhealthyThreshold": integer,
"healthyThreshold": integer
}
| Property name | Value | Description | Notes |
|---|---|---|---|
checkIntervalSec
|
integer
|
How often (in seconds) to send a health check. The default value is
5
seconds.
|
|
creationTimestamp
|
string
|
[Output Only] Creation timestamp in RFC3339 text format. | |
description
|
string
|
An optional textual description of the resource; provided by the client when the resource is created. | |
healthyThreshold
|
integer
|
An unhealthy VM will be marked healthy after this many consecutive successes. The default value is
2
.
|
|
host
|
string
|
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. | |
id
|
unsigned long
|
[Output Only] Unique identifier for the resource; defined by the server. | |
kind
|
string
|
[Output Only]
Type of the resource. Always
compute#httpHealthCheck
.
|
|
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. |
|
port
|
integer
|
The TCP port number for the HTTP health check request. The default value is
80
.
|
|
requestPath
|
string
|
The request path of the HTTP health check request. The default value is
/
.
|
|
selfLink
|
string
|
[Output Only] Server defined URL for the resource. | |
timeoutSec
|
integer
|
How long (in seconds) to wait before claiming failure. The default value is
5
seconds.
|
|
unhealthyThreshold
|
integer
|
A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is
2
.
|
Methods
The following are valid HttpHealthCheck resource methods:
- delete
- Deletes the specified HttpHealthCheck resource.
- get
- Returns the specified HttpHealthCheck resource.
- insert
- Creates a HttpHealthCheck resource in the specified project using the data included in the request.
- list
- Retrieves the list of HttpHealthCheck resources available to the specified project.
- patch
- Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
- update
- Updates a HttpHealthCheck resource in the specified project using the data included in the request.