available_route_rules

Creates, updates, deletes, gets or lists an available_route_rules resource.

Overview

Name	available_route_rules
Type	Resource
Id	ovh.ip_loadbalancing.available_route_rules

Fields

The following fields are returned by SELECT queries:

list

Match rule to combine to build routes

Name	Datatype	Description
name	string	Rule name
enum	array	If pattern is "enum", list of available options
has_sub_field	boolean	If true, this rule needs a subfield. Typically a cookie or header name (wire: hasSubField)
matches	array	List of match operators compatible with this rule
pattern	string	Expected type for the pattern. Like "enum", "backend", "cidr", ...
type	string	Protocol supported by this action

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name		List available route match rules

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"}})
service_name	string	The internal name of your IP load balancing (wire: serviceName)

SELECT examples

list

List available route match rules

SELECT
name,
enum,
has_sub_field,
matches,
pattern,
type
FROM ovh.ip_loadbalancing.available_route_rules
WHERE service_name = '{{ service_name }}' -- required
;