tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.license_cpanel.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	This Task name
task_id	integer	This Task id (wire: taskId)
action	string	This Task description (addWindowFromExistingSerial, changeIp, changeOs, installLicense, optionUpgrade, releaseOption, versionUpgrade)
done_date	string (date-time)	When was this Task done (wire: doneDate)
last_update	string (date-time)	The last time this Task was updated (wire: lastUpdate)
status	string	Current Taks status (cancelled, doing, done, error, todo)
todo_date	string (date-time)	When was this Task created (wire: todoDate)

list

licenses Todos

Name	Datatype	Description
name	string	This Task name
task_id	integer	This Task id (wire: taskId)
action	string	This Task description (addWindowFromExistingSerial, changeIp, changeOs, installLicense, optionUpgrade, releaseOption, versionUpgrade)
done_date	string (date-time)	When was this Task done (wire: doneDate)
last_update	string (date-time)	The last time this Task was updated (wire: lastUpdate)
status	string	Current Taks status (cancelled, doing, done, error, todo)
todo_date	string (date-time)	When was this Task created (wire: todoDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, task_id		Get this object properties
list	select	service_name	action, status, x_pagination_mode	tasks linked to this license

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"}})
service_name	string	The name of your Cpanel license (wire: serviceName)
task_id	integer	This Task id (wire: taskId)
action	string	Filter the value of action 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 this object properties

SELECT
name,
task_id,
action,
done_date,
last_update,
status,
todo_date
FROM ovh.license_cpanel.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

tasks linked to this license

SELECT
name,
task_id,
action,
done_date,
last_update,
status,
todo_date
FROM ovh.license_cpanel.tasks
WHERE service_name = '{{ service_name }}' -- required
AND action = '{{ action }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;