tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.pack_xdsl.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
function	string
status	string	Status of a task. (cancelled, doing, done, error, problem, todo)
update_date	string (date-time)	(wire: updateDate)

list

Describes the current status of a task

Name	Datatype	Description
id	integer
function	string
status	string	Status of a task. (cancelled, doing, done, error, problem, todo)
update_date	string (date-time)	(wire: updateDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, pack_name		Get a task of an xDSL pack. Returns the function, status and last update date of a task scheduled on the pack.
list	select	pack_name	function, status, x_pagination_mode	List the tasks of an xDSL pack. Returns the IDs of the tasks scheduled on the pack. Get a task for its function, status and last update date.

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 of the object
pack_name	string	The internal name of your pack (wire: packName)
function	string	Filter the value of function property (=)
status	string	Filter the value of status 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 a task of an xDSL pack. Returns the function, status and last update date of a task scheduled on the pack.

SELECT
id,
function,
status,
update_date
FROM ovh.pack_xdsl.tasks
WHERE id = '{{ id }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;

list

List the tasks of an xDSL pack. Returns the IDs of the tasks scheduled on the pack. Get a task for its function, status and last update date.

SELECT
id,
function,
status,
update_date
FROM ovh.pack_xdsl.tasks
WHERE pack_name = '{{ pack_name }}' -- required
AND function = '{{ function }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;