tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.dedicated_ceph.tasks

Fields

The following fields are returned by SELECT queries:

list_by_task_id

List of task subtasks

Name	Datatype	Description
name	string	Name of the task
create_date	string	Creation date of the task (wire: createDate)
finish_date	string	Finish date of the task (wire: finishDate)
state	string	State of the task (DONE, FAILED, IN PROGRESS)
type	string	Type of the task

list

List of active tasks

Name	Datatype	Description
id	string	ID of task
name	string	Name of task

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_task_id	select	service_name, task_id		Returns the subtasks of the task, to follow its progress.
list	select	service_name		Returns the tasks running on the cluster.

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	Service name (wire: serviceName)
task_id	string	Task ID (wire: taskId)

SELECT examples

list_by_task_id

Returns the subtasks of the task, to follow its progress.

SELECT
name,
create_date,
finish_date,
state,
type
FROM ovh.dedicated_ceph.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

Returns the tasks running on the cluster.

SELECT
id,
name
FROM ovh.dedicated_ceph.tasks
WHERE service_name = '{{ service_name }}' -- required
;