task_alls

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

Overview

Name	task_alls
Type	Resource
Id	ovh.email_domain.task_alls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of the task
domain	string	Domain name of the task
function	string	Function of the task
status	string	Status of the task (cancelled, customerError, doing, done, init, ovhError, todo)

list

Tasks

Name	Datatype	Description
id	integer	Id of the task
domain	string	Domain name of the task
function	string	Function of the task
status	string	Status of the task (cancelled, customerError, doing, done, init, ovhError, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, id		Get a task. Returns the function, the status and the domain of the task. Tasks of every type are listed under task/all.
list	select	domain	x_pagination_mode	List tasks. Returns the IDs of the tasks of the domain, whatever their type. Get one to read its function and its status.

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"}})
domain	string	Name of your domain name
id	integer	Id of the task
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. Returns the function, the status and the domain of the task. Tasks of every type are listed under task/all.

SELECT
id,
domain,
function,
status
FROM ovh.email_domain.task_alls
WHERE domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
;

list

List tasks. Returns the IDs of the tasks of the domain, whatever their type. Get one to read its function and its status.

SELECT
id,
domain,
function,
status
FROM ovh.email_domain.task_alls
WHERE domain = '{{ domain }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;