region_loadbalancing_health_monitors

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

Overview

Name	region_loadbalancing_health_monitors
Type	Resource
Id	ovh.cloud_network.region_loadbalancing_health_monitors

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	The ID of the pool
name	string	The name of the resource
pool_id	string (uuid)	The ID of the pool (wire: poolId)
delay	integer	Duration between sending probes to members, in seconds
http_configuration	object	Monitor HTTP configuration (wire: httpConfiguration)
max_retries	integer	Number of successful checks before changing the operating status of the member to ONLINE (wire: maxRetries)
max_retries_down	integer	Number of allowed check failures before changing the operating status of the member to ERROR (wire: maxRetriesDown)
monitor_type	string	Type of the monitor (http, https, ping, sctp, tcp, tls-hello, udp-connect) (wire: monitorType)
operating_status	string	The operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
provisioning_status	string	The provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
timeout	integer	Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value

list

HealthMonitor

Name	Datatype	Description
id	string (uuid)	The ID of the pool
name	string	The name of the resource
pool_id	string (uuid)	The ID of the pool (wire: poolId)
delay	integer	Duration between sending probes to members, in seconds
http_configuration	object	Monitor HTTP configuration (wire: httpConfiguration)
max_retries	integer	Number of successful checks before changing the operating status of the member to ONLINE (wire: maxRetries)
max_retries_down	integer	Number of allowed check failures before changing the operating status of the member to ERROR (wire: maxRetriesDown)
monitor_type	string	Type of the monitor (http, https, ping, sctp, tcp, tls-hello, udp-connect) (wire: monitorType)
operating_status	string	The operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
provisioning_status	string	The provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
timeout	integer	Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	health_monitor_id, region_name, service_name		Get details about a loadbalancer health monitor
list	select	region_name, service_name	pool_id	List health monitors
create	insert	region_name, service_name, delay, max_retries, monitor_type, name, pool_id, timeout		Create health monitor
update	update	health_monitor_id, region_name, service_name		Update a health monitor
delete	delete	health_monitor_id, region_name, service_name		Delete health monitor

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
health_monitor_id	string (uuid)	Health monitor ID (wire: healthMonitorId)
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
pool_id	string	Linked pool id (wire: poolId)

SELECT examples

get

Get details about a loadbalancer health monitor

SELECT
id,
name,
pool_id,
delay,
http_configuration,
max_retries,
max_retries_down,
monitor_type,
operating_status,
provisioning_status,
timeout
FROM ovh.cloud_network.region_loadbalancing_health_monitors
WHERE health_monitor_id = '{{ health_monitor_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List health monitors

SELECT
id,
name,
pool_id,
delay,
http_configuration,
max_retries,
max_retries_down,
monitor_type,
operating_status,
provisioning_status,
timeout
FROM ovh.cloud_network.region_loadbalancing_health_monitors
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND pool_id = '{{ pool_id }}'
;

INSERT examples

create

Create health monitor

INSERT INTO ovh.cloud_network.region_loadbalancing_health_monitors (
delay,
http_configuration,
max_retries,
max_retries_down,
monitor_type,
name,
pool_id,
timeout,
region_name,
service_name
)
SELECT 
{{ delay }} /* required */,
'{{ http_configuration }}',
{{ max_retries }} /* required */,
{{ max_retries_down }},
'{{ monitor_type }}' /* required */,
'{{ name }}' /* required */,
'{{ pool_id }}' /* required */,
{{ timeout }} /* required */,
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
pool_id,
delay,
http_configuration,
max_retries,
max_retries_down,
monitor_type,
operating_status,
provisioning_status,
timeout
;

Manifest

# Description fields are for documentation purposes
- name: region_loadbalancing_health_monitors
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_loadbalancing_health_monitors resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_loadbalancing_health_monitors resource.
  - name: delay
    value: {{ delay }}
    description: |
      Duration between sending probes to members, in seconds
  - name: http_configuration
    description: |
      Monitor HTTP configuration
    value:
      domainName: "{{ domainName }}"
      expectedCodes: "{{ expectedCodes }}"
      httpMethod: "{{ httpMethod }}"
      httpVersion: "{{ httpVersion }}"
      urlPath: "{{ urlPath }}"
  - name: max_retries
    value: {{ max_retries }}
    description: |
      Number of successful checks before changing the operating status of the member to ONLINE
  - name: max_retries_down
    value: {{ max_retries_down }}
    description: |
      Number of allowed check failures before changing the operating status of the member to ERROR
  - name: monitor_type
    value: "{{ monitor_type }}"
    description: |
      Type of the monitor
    valid_values: ['http', 'https', 'ping', 'sctp', 'tcp', 'tls-hello', 'udp-connect']
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource
  - name: pool_id
    value: "{{ pool_id }}"
    description: |
      The ID of the pool
  - name: timeout
    value: {{ timeout }}
    description: |
      Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value

UPDATE examples

update

Update a health monitor

UPDATE ovh.cloud_network.region_loadbalancing_health_monitors
SET 
delay = {{ delay }},
http_configuration = '{{ http_configuration }}',
max_retries = {{ max_retries }},
max_retries_down = {{ max_retries_down }},
name = '{{ name }}',
timeout = {{ timeout }}
WHERE 
health_monitor_id = '{{ health_monitor_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
RETURNING
id,
name,
pool_id,
delay,
http_configuration,
max_retries,
max_retries_down,
monitor_type,
operating_status,
provisioning_status,
timeout;

DELETE examples

delete

Delete health monitor

DELETE FROM ovh.cloud_network.region_loadbalancing_health_monitors
WHERE health_monitor_id = '{{ health_monitor_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;