defined_routes
Creates, updates, deletes, gets or lists a defined_routes resource.
Overview​
| Name | defined_routes |
| Type | Resource |
| Id | ovh.ip_loadbalancing.defined_routes |
Fields​
The following fields are returned by SELECT queries:
- list
Defined routes name, type and id. Typically used to generate autocomplete lists.
| Name | Datatype | Description |
|---|---|---|
route_id | integer | Id of your route (wire: routeId) |
display_name | string | Human readable name for your route (wire: displayName) |
type | string | Protocol supported by this route |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | service_name | List defined routes and their type |
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 defined routes and their type
SELECT
route_id,
display_name,
type
FROM ovh.ip_loadbalancing.defined_routes
WHERE service_name = '{{ service_name }}' -- required
;