task_dns

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

Overview

Name	task_dns
Type	Resource
Id	ovh.me.task_dns

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of the task
can_accelerate	boolean	Can accelerate the task (wire: canAccelerate)
can_cancel	boolean	Can cancel the task (wire: canCancel)
can_relaunch	boolean	Can relaunch the task (wire: canRelaunch)
comment	string	Comment about the task
creation_date	string (date-time)	Creation date of the task (wire: creationDate)
done_date	string (date-time)	Done date of the task (wire: doneDate)
function	string	Function of the task (DnsAnycastActivate, DnsAnycastDeactivate, DnssecDisable, DnssecEnable, DnssecResigning, DnssecRollKsk, DnssecRollZsk, ZoneCheck, ZoneCreate, ZoneCut, ZoneDelete, ZoneImport, ZoneRefresh, ZoneRestore)
last_update	string (date-time)	Last update date of the task (wire: lastUpdate)
status	string	Status of the task (cancelled, doing, done, error, problem, todo)
todo_date	string (date-time)	Todo date of the task (wire: todoDate)
zone	string	Zone related to the task

list

DNS task

Name	Datatype	Description
id	integer	Id of the task
can_accelerate	boolean	Can accelerate the task (wire: canAccelerate)
can_cancel	boolean	Can cancel the task (wire: canCancel)
can_relaunch	boolean	Can relaunch the task (wire: canRelaunch)
comment	string	Comment about the task
creation_date	string (date-time)	Creation date of the task (wire: creationDate)
done_date	string (date-time)	Done date of the task (wire: doneDate)
function	string	Function of the task (DnsAnycastActivate, DnsAnycastDeactivate, DnssecDisable, DnssecEnable, DnssecResigning, DnssecRollKsk, DnssecRollZsk, ZoneCheck, ZoneCreate, ZoneCut, ZoneDelete, ZoneImport, ZoneRefresh, ZoneRestore)
last_update	string (date-time)	Last update date of the task (wire: lastUpdate)
status	string	Status of the task (cancelled, doing, done, error, problem, todo)
todo_date	string (date-time)	Todo date of the task (wire: todoDate)
zone	string	Zone related to the task

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get a zone task
list	select		function, status, zone, x_pagination_mode	List zone tasks
accelerate	exec	id		Accelerate the task
cancel	exec	id		Cancel the task
relaunch	exec	id		Relaunch the task

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"}})
id	integer	Id
function	string
status	string
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)
zone	string

SELECT examples

get

Get a zone task

SELECT
id,
can_accelerate,
can_cancel,
can_relaunch,
comment,
creation_date,
done_date,
function,
last_update,
status,
todo_date,
zone
FROM ovh.me.task_dns
WHERE id = '{{ id }}' -- required
;

list

List zone tasks

SELECT
id,
can_accelerate,
can_cancel,
can_relaunch,
comment,
creation_date,
done_date,
function,
last_update,
status,
todo_date,
zone
FROM ovh.me.task_dns
WHERE function = '{{ function }}'
AND status = '{{ status }}'
AND zone = '{{ zone }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

accelerate

Accelerate the task

EXEC ovh.me.task_dns.accelerate 
@id='{{ id }}' --required
;

cancel

Cancel the task

EXEC ovh.me.task_dns.cancel 
@id='{{ id }}' --required
;

relaunch

Relaunch the task

EXEC ovh.me.task_dns.relaunch 
@id='{{ id }}' --required
;