domains_backends

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

Overview

Name	domains_backends
Type	Resource
Id	ovh.cdn_dedicated.domains_backends

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
ip	string (ipv4)	IPv4 address (e.g., 192.0.2.0) (example: 192.0.2.0)

list

Backend for a domain

Name	Datatype	Description
ip	string (ipv4)	IPv4 address (e.g., 192.0.2.0) (example: 192.0.2.0)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, ip, service_name		Get a backend
list	select	domain, service_name	x_pagination_mode	List backends
create	insert	domain, service_name, ip		Create a backend
delete	delete	domain, ip, service_name		Delete a backend

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"}})
domain	string	Domain of this object
ip	string (ipv4)
service_name	string	The internal name of your CDN offer (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a backend

SELECT
ip
FROM ovh.cdn_dedicated.domains_backends
WHERE domain = '{{ domain }}' -- required
AND ip = '{{ ip }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List backends

SELECT
ip
FROM ovh.cdn_dedicated.domains_backends
WHERE domain = '{{ domain }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a backend

INSERT INTO ovh.cdn_dedicated.domains_backends (
ip,
domain,
service_name
)
SELECT 
'{{ ip }}' /* required */,
'{{ domain }}',
'{{ service_name }}'
RETURNING
ip
;

Manifest

# Description fields are for documentation purposes
- name: domains_backends
props:
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the domains_backends resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the domains_backends resource.
  - name: ip
    value: "{{ ip }}"
    description: |
      IP to add to backends list

DELETE examples

delete

Delete a backend

DELETE FROM ovh.cdn_dedicated.domains_backends
WHERE domain = '{{ domain }}' --required
AND ip = '{{ ip }}' --required
AND service_name = '{{ service_name }}' --required
;