https_health_checks

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

Overview

Name	https_health_checks
Type	Resource
Id	google.compute.https_health_checks

Fields

The following fields are returned by SELECT queries:

get

Successful response

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 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. (pattern: a-z?)
checkIntervalSec	integer (int32)	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 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 HTTPS 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	Type of the resource. (default: compute#httpsHealthCheck)
port	integer (int32)	The TCP port number for the HTTPS health check request. The default value is 443.
requestPath	string	The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986.
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 is 5 seconds. It is invalid for timeoutSec to have a 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.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of HttpsHealthCheck resources.
kind	string	Type of resource. (default: compute#httpsHealthCheckList)
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 than maxResults, 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] 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, httpsHealthCheck		Returns the specified HttpsHealthCheck resource.
list	select	project	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of HttpsHealthCheck resources available to the specified project.
insert	insert	project	requestId	Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
patch	update	project, httpsHealthCheck	requestId	Updates a HttpsHealthCheck 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.
update	replace	project, httpsHealthCheck	requestId	Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
delete	delete	project, httpsHealthCheck	requestId	Deletes the specified HttpsHealthCheck 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
httpsHealthCheck	string
project	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified HttpsHealthCheck resource.

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

list

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

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

INSERT examples

insert

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

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

Manifest

# Description fields are for documentation purposes
- name: https_health_checks
  props:
    - name: project
      value: string
      description: Required parameter for the https_health_checks resource.
    - name: kind
      value: string
      description: >
        Type of the resource.
        
      default: compute#httpsHealthCheck
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: host
      value: string
      description: >
        The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
        
    - name: requestPath
      value: string
      description: >
        The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986.
        
    - name: port
      value: integer
      description: >
        The TCP port number for the HTTPS health check request. The default value is 443.
        
    - name: checkIntervalSec
      value: integer
      description: >
        How often (in seconds) to send a health check. The default value is 5 seconds.
        
    - name: timeoutSec
      value: integer
      description: >
        How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
        
    - name: unhealthyThreshold
      value: integer
      description: >
        A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
        
    - name: healthyThreshold
      value: integer
      description: >
        A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: requestId
      value: string

UPDATE examples

patch

Updates a HttpsHealthCheck 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.

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

REPLACE examples

update

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

REPLACE google.compute.https_health_checks
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__host = '{{ host }}',
data__requestPath = '{{ requestPath }}',
data__port = {{ port }},
data__checkIntervalSec = {{ checkIntervalSec }},
data__timeoutSec = {{ timeoutSec }},
data__unhealthyThreshold = {{ unhealthyThreshold }},
data__healthyThreshold = {{ healthyThreshold }},
data__selfLink = '{{ selfLink }}'
WHERE 
project = '{{ project }}' --required
AND httpsHealthCheck = '{{ httpsHealthCheck }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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 HttpsHealthCheck resource.

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