cdns

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

Overview

Name	cdns
Type	Resource
Id	ovh.cdn_dedicated.cdns

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
anycast	string (ipv4)	IPv4 address (e.g., 192.0.2.0) (example: 192.0.2.0)
backend_limit	integer	(wire: backendLimit)
backend_use	integer	(wire: backendUse)
cache_rule_limit_per_domain	integer	(wire: cacheRuleLimitPerDomain)
iam	object	IAM resource metadata
last_quota_order	string (date-time)	(wire: lastQuotaOrder)
log_url	string	URL for downloading daily log of your CDN (wire: logUrl)
offer	string
quota	integer
service	string	The internal name of your CDN offer

list

Anycast IP of a CDN customer

Name	Datatype	Description
anycast	string (ipv4)	IPv4 address (e.g., 192.0.2.0) (example: 192.0.2.0)
backend_limit	integer	(wire: backendLimit)
backend_use	integer	(wire: backendUse)
cache_rule_limit_per_domain	integer	(wire: cacheRuleLimitPerDomain)
iam	object	IAM resource metadata
last_quota_order	string (date-time)	(wire: lastQuotaOrder)
log_url	string	URL for downloading daily log of your CDN (wire: logUrl)
offer	string
quota	integer
service	string	The internal name of your CDN offer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get a CDN service
list	select		iam_tags, x_pagination_mode	List CDN services
change_contact	exec	serviceName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
log_url	exec	serviceName, kind		Generates a temporary URL to read the logs of one kind. The URL expires.
logs	exec	serviceName		Generate a 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"}})
serviceName	string	The internal name of your CDN offer
service_name	string	The internal name of your CDN offer (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 CDN service

SELECT
anycast,
backend_limit,
backend_use,
cache_rule_limit_per_domain,
iam,
last_quota_order,
log_url,
offer,
quota,
service
FROM ovh.cdn_dedicated.cdns
WHERE service_name = '{{ service_name }}' -- required
;

list

List CDN services

SELECT
anycast,
backend_limit,
backend_use,
cache_rule_limit_per_domain,
iam,
last_quota_order,
log_url,
offer,
quota,
service
FROM ovh.cdn_dedicated.cdns
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

EXEC ovh.cdn_dedicated.cdns.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

log_url

Generates a temporary URL to read the logs of one kind. The URL expires.

EXEC ovh.cdn_dedicated.cdns.log_url 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"kind": "{{ kind }}"
}'
;

logs

Generate a real time logs URL (Beta version)

EXEC ovh.cdn_dedicated.cdns.logs 
@serviceName='{{ serviceName }}' --required
;