http_health_checks

Creates, updates, deletes, gets or lists a http_health_checks resource.

Overview

Name	`http_health_checks`
Type	Resource
Id	`google.compute.http_health_checks`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`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 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`checkIntervalSec`	`integer (int32)`	How often (in seconds) to send a health check. The default value is5 seconds.
`creationTimestamp`	`string`	[Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`healthyThreshold`	`integer (int32)`	A so-far unhealthy instance 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.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks. (default: compute#httpHealthCheck)
`port`	`integer (int32)`	The TCP port number for the HTTP health check request. The default value is80.
`requestPath`	`string`	The request path of the HTTP health check request. The default value is/. This field does not support query parameters. Must comply withRFC3986.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`timeoutSec`	`integer (int32)`	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.
`unhealthyThreshold`	`integer (int32)`	A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of HttpHealthCheck resources.
`kind`	`string`	Output only. Type of resource. (default: compute#httpHealthCheckList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `httpHealthCheck`		Returns the specified HttpHealthCheck resource.
`list`	`select`	`project`	`returnPartialSuccess`, `maxResults`, `pageToken`, `filter`, `orderBy`	Retrieves the list of HttpHealthCheck resources available to the specified project.
`insert`	`insert`	`project`	`requestId`	Creates a HttpHealthCheck resource in the specified project using the data included in the request.
`patch`	`update`	`project`, `httpHealthCheck`	`requestId`	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.
`update`	`replace`	`project`, `httpHealthCheck`	`requestId`	Updates a HttpHealthCheck resource in the specified project using the data included in the request.
`delete`	`delete`	`project`, `httpHealthCheck`	`requestId`	Deletes the specified HttpHealthCheck resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`httpHealthCheck`	`string`
`project`	`string`
`filter`	`string`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`

`SELECT` examples

get
list

Returns the specified HttpHealthCheck resource.

SELECT
id,
name,
checkIntervalSec,
creationTimestamp,
description,
healthyThreshold,
host,
kind,
port,
requestPath,
selfLink,
timeoutSec,
unhealthyThreshold
FROM google.compute.http_health_checks
WHERE project = '{{ project }}' -- required
AND httpHealthCheck = '{{ httpHealthCheck }}' -- required
;

Retrieves the list of HttpHealthCheck resources available to the specified
project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.http_health_checks
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

`INSERT` examples

insert
Manifest

Creates a HttpHealthCheck resource in the specified project using the data
included in the request.

INSERT INTO google.compute.http_health_checks (
data__healthyThreshold,
data__host,
data__unhealthyThreshold,
data__checkIntervalSec,
data__creationTimestamp,
data__port,
data__timeoutSec,
data__description,
data__id,
data__requestPath,
data__selfLink,
data__name,
project,
requestId
)
SELECT 
{{ healthyThreshold }},
'{{ host }}',
{{ unhealthyThreshold }},
{{ checkIntervalSec }},
'{{ creationTimestamp }}',
{{ port }},
{{ timeoutSec }},
'{{ description }}',
'{{ id }}',
'{{ requestPath }}',
'{{ selfLink }}',
'{{ name }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: http_health_checks
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the http_health_checks resource.
  - name: healthyThreshold
    value: {{ healthyThreshold }}
    description: |
      A so-far unhealthy instance will be marked healthy after this
      many consecutive successes. The default value is 2.
  - name: host
    value: "{{ host }}"
    description: |
      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.
  - name: unhealthyThreshold
    value: {{ unhealthyThreshold }}
    description: |
      A so-far healthy instance will be marked unhealthy after this
      many consecutive failures. The default value is 2.
  - name: checkIntervalSec
    value: {{ checkIntervalSec }}
    description: |
      How often (in seconds) to send a health check. The default value is5 seconds.
  - name: creationTimestamp
    value: "{{ creationTimestamp }}"
    description: |
      [Output Only] Creation timestamp inRFC3339
      text format.
  - name: port
    value: {{ port }}
    description: |
      The TCP port number for the HTTP health check request. The default value is80.
  - name: timeoutSec
    value: {{ timeoutSec }}
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: requestPath
    value: "{{ requestPath }}"
    description: |
      The request path of the HTTP health check request. The default value is/. This field does not support query
      parameters. Must comply withRFC3986.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: name
    value: "{{ name }}"
    description: |
      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.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

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.

UPDATE google.compute.http_health_checks
SET 
data__healthyThreshold = {{ healthyThreshold }},
data__host = '{{ host }}',
data__unhealthyThreshold = {{ unhealthyThreshold }},
data__checkIntervalSec = {{ checkIntervalSec }},
data__creationTimestamp = '{{ creationTimestamp }}',
data__port = {{ port }},
data__timeoutSec = {{ timeoutSec }},
data__description = '{{ description }}',
data__id = '{{ id }}',
data__requestPath = '{{ requestPath }}',
data__selfLink = '{{ selfLink }}',
data__name = '{{ name }}'
WHERE 
project = '{{ project }}' --required
AND httpHealthCheck = '{{ httpHealthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`REPLACE` examples

update

Updates a HttpHealthCheck resource in the specified project using the data
included in the request.

REPLACE google.compute.http_health_checks
SET 
data__healthyThreshold = {{ healthyThreshold }},
data__host = '{{ host }}',
data__unhealthyThreshold = {{ unhealthyThreshold }},
data__checkIntervalSec = {{ checkIntervalSec }},
data__creationTimestamp = '{{ creationTimestamp }}',
data__port = {{ port }},
data__timeoutSec = {{ timeoutSec }},
data__description = '{{ description }}',
data__id = '{{ id }}',
data__requestPath = '{{ requestPath }}',
data__selfLink = '{{ selfLink }}',
data__name = '{{ name }}'
WHERE 
project = '{{ project }}' --required
AND httpHealthCheck = '{{ httpHealthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified HttpHealthCheck resource.

DELETE FROM google.compute.http_health_checks
WHERE project = '{{ project }}' --required
AND httpHealthCheck = '{{ httpHealthCheck }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​