domains_cache_rules_tasks

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

Overview

Name	domains_cache_rules_tasks
Type	Resource
Id	ovh.cdn_dedicated.domains_cache_rules_tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	(wire: taskId)
comment	string
function	string	All function CDN task can be (flush, flushAll, generateSsl, installSsl, reinstallSsl, removeDomain, uninstallSsl, updateCacheRule)
status	string	All states a CDN task can be in (cancelled, doing, done, error, todo)

list

Task on a CDN

Name	Datatype	Description
task_id	integer	(wire: taskId)
comment	string
function	string	All function CDN task can be (flush, flushAll, generateSsl, installSsl, reinstallSsl, removeDomain, uninstallSsl, updateCacheRule)
status	string	All states a CDN task can be in (cancelled, doing, done, error, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cache_rule_id, domain, service_name, task_id		Get a task
list	select	cache_rule_id, domain, service_name	x_pagination_mode	List cache rule tasks

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"}})
cache_rule_id	integer	Id for this cache rule (wire: cacheRuleId)
domain	string	Domain of this object
service_name	string	The internal name of your CDN offer (wire: serviceName)
task_id	integer	(wire: taskId)
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 task

SELECT
task_id,
comment,
function,
status
FROM ovh.cdn_dedicated.domains_cache_rules_tasks
WHERE cache_rule_id = '{{ cache_rule_id }}' -- required
AND domain = '{{ domain }}' -- required
AND service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List cache rule tasks

SELECT
task_id,
comment,
function,
status
FROM ovh.cdn_dedicated.domains_cache_rules_tasks
WHERE cache_rule_id = '{{ cache_rule_id }}' -- required
AND domain = '{{ domain }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;