target_pools_health_check

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

Overview

Name	target_pools_health_check
Type	Resource
Id	google.compute.target_pools_health_check

Fields

The following fields are returned by SELECT queries:

get_health

Name	Datatype	Description
healthStatus	array
kind	string	Output only. [Output Only] Type of resource. Alwayscompute#targetPoolInstanceHealth when checking the health of an instance. (default: compute#targetPoolInstanceHealth)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_health	select	project, region, targetPool		Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
add_health_check	insert	project, region, targetPool	requestId	Adds health check URLs to a target pool.
remove_health_check	delete	project, region, targetPool	requestId	Removes health check URL from a target pool.

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
project	string
region	string
targetPool	string
requestId	string

SELECT examples

get_health

Gets the most recent health check results for each IP for the
instance that is referenced by the given target pool.

SELECT
healthStatus,
kind
FROM google.compute.target_pools_health_check
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND targetPool = '{{ targetPool }}' -- required
;

INSERT examples

add_health_check

Adds health check URLs to a target pool.

INSERT INTO google.compute.target_pools_health_check (
data__healthChecks,
project,
region,
targetPool,
requestId
)
SELECT 
'{{ healthChecks }}',
'{{ project }}',
'{{ region }}',
'{{ targetPool }}',
'{{ 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
;

Manifest

# Description fields are for documentation purposes
- name: target_pools_health_check
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the target_pools_health_check resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the target_pools_health_check resource.
  - name: targetPool
    value: "{{ targetPool }}"
    description: Required parameter for the target_pools_health_check resource.
  - name: healthChecks
    description: |
      The HttpHealthCheck to add to the target pool.
    value:
      - healthCheck: "{{ healthCheck }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

remove_health_check

Removes health check URL from a target pool.

DELETE FROM google.compute.target_pools_health_check
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND targetPool = '{{ targetPool }}' --required
AND requestId = '{{ requestId }}'
;