tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.dedicated_nasha.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	id of the task (wire: taskId)
partition_name	string	name of the partition (wire: partitionName)
storage_name	string	the name of your service (wire: storageName)
details	string	information about operation
done_date	string (date-time)	the date when the task finished (wire: doneDate)
last_update	string (date-time)	last modification of task (wire: lastUpdate)
operation	string	Task type of operation (backupRecursiveDestroy, clusterLeclercAclUpdate, clusterLeclercChangeServiceIp, clusterLeclercCustomSnapCreate, clusterLeclercCustomSnapDelete, clusterLeclercDeleteSnapshotDirectory, clusterLeclercDestroyNasContainer, clusterLeclercPartitionAdd, clusterLeclercPartitionDelete, clusterLeclercPartitionUpdate, clusterLeclercQuotaUpdate, clusterLeclercSetupNasContainer, clusterLeclercSnapshotUpdate, clusterLeclercZfsOptions, nasAclUpdate, nasDeleteSnapshotDirectory, nasPartitionAdd, nasPartitionDelete, nasPartitionUpdate, nasQuotaUpdate, remoteBackupRecursiveDestroy)
status	string	The actual state of the task (cancelled, customerError, doing, done, init, ovhError, todo)
todo_date	string (date-time)	Insertion of task in the todo (wire: todoDate)

list

Storage task

Name	Datatype	Description
task_id	integer	id of the task (wire: taskId)
partition_name	string	name of the partition (wire: partitionName)
storage_name	string	the name of your service (wire: storageName)
details	string	information about operation
done_date	string (date-time)	the date when the task finished (wire: doneDate)
last_update	string (date-time)	last modification of task (wire: lastUpdate)
operation	string	Task type of operation (backupRecursiveDestroy, clusterLeclercAclUpdate, clusterLeclercChangeServiceIp, clusterLeclercCustomSnapCreate, clusterLeclercCustomSnapDelete, clusterLeclercDeleteSnapshotDirectory, clusterLeclercDestroyNasContainer, clusterLeclercPartitionAdd, clusterLeclercPartitionDelete, clusterLeclercPartitionUpdate, clusterLeclercQuotaUpdate, clusterLeclercSetupNasContainer, clusterLeclercSnapshotUpdate, clusterLeclercZfsOptions, nasAclUpdate, nasDeleteSnapshotDirectory, nasPartitionAdd, nasPartitionDelete, nasPartitionUpdate, nasQuotaUpdate, remoteBackupRecursiveDestroy)
status	string	The actual state of the task (cancelled, customerError, doing, done, init, ovhError, todo)
todo_date	string (date-time)	Insertion of task in the todo (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	operation, status, x_pagination_mode	View task list

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 storage (wire: serviceName)
task_id	integer	id of the task (wire: taskId)
operation	string	Filter the value of operation 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,
partition_name,
storage_name,
details,
done_date,
last_update,
operation,
status,
todo_date
FROM ovh.dedicated_nasha.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

View task list

SELECT
task_id,
partition_name,
storage_name,
details,
done_date,
last_update,
operation,
status,
todo_date
FROM ovh.dedicated_nasha.tasks
WHERE service_name = '{{ service_name }}' -- required
AND operation = '{{ operation }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;