tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.ssl_gateway.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of the task
action	string	The action made (addDomain, addPaidCertificate, addServer, createService, deleteDomain, deleteServer, deleteService, internalTask, updateServer, updateService, upgrade)
creation_date	string (date-time)	Creation date of your task (wire: creationDate)
progress	integer	Task progress percentage
status	string	Current status of your task (blocked, cancelled, doing, done, error, paused, todo)

list

SSL Gateway tasks

Name	Datatype	Description
id	integer	Id of the task
action	string	The action made (addDomain, addPaidCertificate, addServer, createService, deleteDomain, deleteServer, deleteService, internalTask, updateServer, updateService, upgrade)
creation_date	string (date-time)	Creation date of your task (wire: creationDate)
progress	integer	Task progress percentage
status	string	Current status of your task (blocked, cancelled, doing, done, error, paused, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get a task (Beta version)
list	select	service_name	x_pagination_mode	List tasks (Beta version)

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"}})
id	integer	Id of the task
service_name	string	The internal name of your SSL Gateway (wire: serviceName)
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 (Beta version)

SELECT
id,
action,
creation_date,
progress,
status
FROM ovh.ssl_gateway.tasks
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List tasks (Beta version)

SELECT
id,
action,
creation_date,
progress,
status
FROM ovh.ssl_gateway.tasks
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;