tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.ip_loadbalancing.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of the operation
action	string	Operation type (deleteIplb, deployIplb, install, installIplb, installZone, orderFreeCertificate, orderPaidCertificate, orderSsl, refreshIplb, releaseIplb, releaseIplbZone, reopenIplb, suspendIplb, suspendZone, switchToIplbNextGenerationApi, vrackAttach, vrackDetach)
creation_date	string (date-time)	Creation date of your operation (wire: creationDate)
done_date	string (date-time)	Done date of your operation (wire: doneDate)
progress	integer	Operation progress percentage
status	string	Current status of your operation (blocked, cancelled, doing, done, error, todo)
zones	array	Zone of your Load Balancer which are updated by current Task

list

IP Load Balancing Operations

Name	Datatype	Description
id	integer	Id of the operation
action	string	Operation type (deleteIplb, deployIplb, install, installIplb, installZone, orderFreeCertificate, orderPaidCertificate, orderSsl, refreshIplb, releaseIplb, releaseIplbZone, reopenIplb, suspendIplb, suspendZone, switchToIplbNextGenerationApi, vrackAttach, vrackDetach)
creation_date	string (date-time)	Creation date of your operation (wire: creationDate)
done_date	string (date-time)	Done date of your operation (wire: doneDate)
progress	integer	Operation progress percentage
status	string	Current status of your operation (blocked, cancelled, doing, done, error, todo)
zones	array	Zone of your Load Balancer which are updated by current Task

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
list	select	service_name	action, creation_date.from, creation_date.to, done_date.from, done_date.to, status, x_pagination_mode	List tasks

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 operation
service_name	string	The internal name of your IP load balancing (wire: serviceName)
action	string	Filter the value of action property (=)
creation_date.from	string (date-time)	Filter the value of creationDate property (>=) (wire: creationDate.from)
creation_date.to	string (date-time)	Filter the value of creationDate property (<=) (wire: creationDate.to)
done_date.from	string (date-time)	Filter the value of doneDate property (>=) (wire: doneDate.from)
done_date.to	string (date-time)	Filter the value of doneDate property (<=) (wire: doneDate.to)
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 a task

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

list

List tasks

SELECT
id,
action,
creation_date,
done_date,
progress,
status,
zones
FROM ovh.ip_loadbalancing.tasks
WHERE service_name = '{{ service_name }}' -- required
AND action = '{{ action }}'
AND creation_date.from = '{{ creation_date.from }}'
AND creation_date.to = '{{ creation_date.to }}'
AND done_date.from = '{{ done_date.from }}'
AND done_date.to = '{{ done_date.to }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;