tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.dedicated_housing.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	the id of the task (wire: taskId)
comment	string	Details of this task
done_date	string (date-time)	Completion date (wire: doneDate)
function	string	Function name (applyBackupFtpAcls, applyBackupFtpQuota, changePasswordBackupFTP, createBackupFTP, migrateBackupFTP, removeBackupFTP)
last_update	string (date-time)	last update (wire: lastUpdate)
start_date	string (date-time)	Task Creation date (wire: startDate)
status	string	Task status (cancelled, customerError, doing, done, init, ovhError, todo)

list

Housing tasks

Name	Datatype	Description
task_id	integer	the id of the task (wire: taskId)
comment	string	Details of this task
done_date	string (date-time)	Completion date (wire: doneDate)
function	string	Function name (applyBackupFtpAcls, applyBackupFtpQuota, changePasswordBackupFTP, createBackupFTP, migrateBackupFTP, removeBackupFTP)
last_update	string (date-time)	last update (wire: lastUpdate)
start_date	string (date-time)	Task Creation date (wire: startDate)
status	string	Task status (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	service_name, task_id		Get this object properties
list	select	service_name	function, status, x_pagination_mode	View task list
cancel	exec	serviceName, taskId		this action stop the task progression if it's possible

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"}})
serviceName	string	The internal name of your Housing bay
service_name	string	The internal name of your Housing bay (wire: serviceName)
taskId	integer	the id of the task
task_id	integer	the id of the task (wire: taskId)
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 this object properties

SELECT
task_id,
comment,
done_date,
function,
last_update,
start_date,
status
FROM ovh.dedicated_housing.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

View task list

SELECT
task_id,
comment,
done_date,
function,
last_update,
start_date,
status
FROM ovh.dedicated_housing.tasks
WHERE service_name = '{{ service_name }}' -- required
AND function = '{{ function }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

cancel

this action stop the task progression if it's possible

EXEC ovh.dedicated_housing.tasks.cancel 
@serviceName='{{ serviceName }}' --required, 
@taskId='{{ taskId }}' --required
;