domains

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

Overview

Name	domains
Type	Resource
Id	ovh.cdn_dedicated.domains

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
cache_rule_use	integer	(wire: cacheRuleUse)
cname	string
domain	string	Domain of this object
status	string	All states a status can be in (error, off, on, removing)
type	string	All type of Domain (plain, ssl)

list

Domain on CDN

Name	Datatype	Description
cache_rule_use	integer	(wire: cacheRuleUse)
cname	string
domain	string	Domain of this object
status	string	All states a status can be in (error, off, on, removing)
type	string	All type of Domain (plain, ssl)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, service_name		Get a domain
list	select	service_name	x_pagination_mode	List domains
create	insert	service_name, domain		Create a domain
update	update	domain, service_name		Update a domain
delete	delete	domain, service_name		Delete a domain
flush	exec	domain, serviceName		Flush the domain cache
logs	exec	domain, serviceName		Generate a domain real time logs URL (Beta version)

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
serviceName	string	The internal name of your CDN offer
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 domain

SELECT
cache_rule_use,
cname,
domain,
status,
type
FROM ovh.cdn_dedicated.domains
WHERE domain = '{{ domain }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List domains

SELECT
cache_rule_use,
cname,
domain,
status,
type
FROM ovh.cdn_dedicated.domains
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a domain

INSERT INTO ovh.cdn_dedicated.domains (
domain,
service_name
)
SELECT 
'{{ domain }}' /* required */,
'{{ service_name }}'
RETURNING
cache_rule_use,
cname,
domain,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the domains resource.
  - name: domain
    value: "{{ domain }}"
    description: |
      domain name to add on CDN

UPDATE examples

update

Update a domain

UPDATE ovh.cdn_dedicated.domains
SET 
status = '{{ status }}'
WHERE 
domain = '{{ domain }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a domain

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

Lifecycle Methods

EXEC variables use wire (API) names.

flush

Flush the domain cache

EXEC ovh.cdn_dedicated.domains.flush 
@domain='{{ domain }}' --required, 
@serviceName='{{ serviceName }}' --required
;

logs

Generate a domain real time logs URL (Beta version)

EXEC ovh.cdn_dedicated.domains.logs 
@domain='{{ domain }}' --required, 
@serviceName='{{ serviceName }}' --required
;