tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.domain.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)
domain	string	Domain of the task
done_date	string (date-time)	Done date of the task (wire: doneDate)
function	string	Function of the task
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)
type	string	type of the task (alldom, domain)

list

Tasks associated to domain

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)
domain	string	Domain of the task
done_date	string (date-time)	Done date of the task (wire: doneDate)
function	string	Function of the task
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)
type	string	type of the task (alldom, domain)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get details about a domain task
list	select	service_name	function, status, type, x_pagination_mode	List all domain tasks
accelerate	exec	id, serviceName		Accelerate the task
cancel	exec	id, serviceName		Cancel the task
relaunch	exec	id, serviceName		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
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
function	string	Filter the value of function property (like)
status	string	Filter the value of status property (=)
type	string	Filter the value of type property (=)
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 details about a domain task

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

list

List all domain tasks

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

Lifecycle Methods

EXEC variables use wire (API) names.

accelerate

Accelerate the task

EXEC ovh.domain.tasks.accelerate 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;

cancel

Cancel the task

EXEC ovh.domain.tasks.cancel 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;

relaunch

Relaunch the task

EXEC ovh.domain.tasks.relaunch 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;