tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.sms.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	(wire: taskId)
function	string	The task function (cleanSmsReceivers)
status	string	Task status (doing, done, error, pause, todo)
step	string	The task step (checkOrder, createHlrs, finishing, sendMailReport, starting, waitForHlrs)

list

Operation on a SMS service

Name	Datatype	Description
task_id	integer	(wire: taskId)
function	string	The task function (cleanSmsReceivers)
status	string	Task status (doing, done, error, pause, todo)
step	string	The task step (checkOrder, createHlrs, finishing, sendMailReport, starting, waitForHlrs)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, task_id		Get a task. Returns an operation run on the SMS account, with the function performed, its current step and its status.
list	select	service_name	status, x_pagination_mode	List tasks. Returns the identifiers of the operations run on the SMS account. Get a task for its function, current step and 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"}})
service_name	string	The internal name of your SMS offer (wire: serviceName)
task_id	integer	(wire: taskId)
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. Returns an operation run on the SMS account, with the function performed, its current step and its status.

SELECT
task_id,
function,
status,
step
FROM ovh.sms.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List tasks. Returns the identifiers of the operations run on the SMS account. Get a task for its function, current step and status.

SELECT
task_id,
function,
status,
step
FROM ovh.sms.tasks
WHERE service_name = '{{ service_name }}' -- required
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;