zone_tasks

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

Overview

Name	zone_tasks
Type	Resource
Id	ovh.domain.zone_tasks

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)

list

DNS zone 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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, zone_name		Returns a task: function, status, dates, and whether it can be accelerated, canceled or relaunched.
list	select	zone_name	function, status, x_pagination_mode	Returns the identifiers of the zone tasks. Can be filtered by function and status.
accelerate	exec	id, zoneName		Accelerates a task. Only possible when canAccelerate is true on the task.
cancel	exec	id, zoneName		Cancels a task. Only possible when canCancel is true on the task.
relaunch	exec	id, zoneName		Relaunches a task. Only possible when canRelaunch is true on 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
zoneName	string	Zone name
zone_name	string	Zone name (wire: zoneName)
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)

SELECT examples

get

Returns a task: function, status, dates, and whether it can be accelerated, canceled or relaunched.

SELECT
id,
can_accelerate,
can_cancel,
can_relaunch,
comment,
creation_date,
done_date,
function,
last_update,
status,
todo_date
FROM ovh.domain.zone_tasks
WHERE id = '{{ id }}' -- required
AND zone_name = '{{ zone_name }}' -- required
;

list

Returns the identifiers of the zone tasks. Can be filtered by function and status.

SELECT
id,
can_accelerate,
can_cancel,
can_relaunch,
comment,
creation_date,
done_date,
function,
last_update,
status,
todo_date
FROM ovh.domain.zone_tasks
WHERE zone_name = '{{ zone_name }}' -- required
AND function = '{{ function }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

accelerate

Accelerates a task. Only possible when canAccelerate is true on the task.

EXEC ovh.domain.zone_tasks.accelerate 
@id='{{ id }}' --required, 
@zoneName='{{ zoneName }}' --required
;

cancel

Cancels a task. Only possible when canCancel is true on the task.

EXEC ovh.domain.zone_tasks.cancel 
@id='{{ id }}' --required, 
@zoneName='{{ zoneName }}' --required
;

relaunch

Relaunches a task. Only possible when canRelaunch is true on the task.

EXEC ovh.domain.zone_tasks.relaunch 
@id='{{ id }}' --required, 
@zoneName='{{ zoneName }}' --required
;