tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.vrack.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
order_id	integer	(wire: orderId)
service_name	string	(wire: serviceName)
function	string
last_update	string (date-time)	(wire: lastUpdate)
status	string	Task status (cancelled, doing, done, init, todo)
target_domain	string	(wire: targetDomain)
todo_date	string (date-time)	(wire: todoDate)

list

vrack tasks

Name	Datatype	Description
id	integer
order_id	integer	(wire: orderId)
service_name	string	(wire: serviceName)
function	string
last_update	string (date-time)	(wire: lastUpdate)
status	string	Task status (cancelled, doing, done, init, todo)
target_domain	string	(wire: targetDomain)
todo_date	string (date-time)	(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 a task. Returns the function, status, target and dates of the task.
list	select	service_name	x_pagination_mode	List tasks. Returns the identifiers of the tasks run on the vRack.

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 vrack (wire: serviceName)
task_id	integer	(wire: taskId)
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, status, target and dates of the task.

SELECT
id,
order_id,
service_name,
function,
last_update,
status,
target_domain,
todo_date
FROM ovh.vrack.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List tasks. Returns the identifiers of the tasks run on the vRack.

SELECT
id,
order_id,
service_name,
function,
last_update,
status,
target_domain,
todo_date
FROM ovh.vrack.tasks
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;