tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.email_mxplan.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Task id
finish_date	string (date-time)	Completion date (wire: finishDate)
function	string	Function name (addAccount, addAlias, addDomain, addDomainDKIM, addDomainDisclaimer, addExternalContact, addFullAccess, addSendAs, addSendOnBehalfTo, addServiceAuthorizedIp, changeHostname, changePassword, configureCustomer, deleteAccount, deleteAlias, deleteDomain, deleteDomainDKIM, deleteDomainDisclaimer, deleteExternalContact, deleteFullAccess, deleteSendAs, deleteSendOnBehalfTo, deleteService, deleteServiceAuthorizedIp, diagnoseAccount, disableDKIM, enableDKIM, expandDrive, installServer, maintenance, migrateAccountViaOMM, migrationAccount, migrationDisclaimer, migrationExternalContact, migrationHistory, migrationService, reOpenAccount, setAccount, setAlias, setDns, setDomain, setDomainDisclaimer, setExternalContact, setService, suspendAccount, suspendService, unknown, unsuspendAccount, unsuspendService)
status	string	Task status (cancelled, doing, done, error, todo)
todo_date	string (date-time)	Creation date (wire: todoDate)

list

Organization task details

Name	Datatype	Description
id	integer	Task id
finish_date	string (date-time)	Completion date (wire: finishDate)
function	string	Function name (addAccount, addAlias, addDomain, addDomainDKIM, addDomainDisclaimer, addExternalContact, addFullAccess, addSendAs, addSendOnBehalfTo, addServiceAuthorizedIp, changeHostname, changePassword, configureCustomer, deleteAccount, deleteAlias, deleteDomain, deleteDomainDKIM, deleteDomainDisclaimer, deleteExternalContact, deleteFullAccess, deleteSendAs, deleteSendOnBehalfTo, deleteService, deleteServiceAuthorizedIp, diagnoseAccount, disableDKIM, enableDKIM, expandDrive, installServer, maintenance, migrateAccountViaOMM, migrationAccount, migrationDisclaimer, migrationExternalContact, migrationHistory, migrationService, reOpenAccount, setAccount, setAlias, setDns, setDomain, setDomainDisclaimer, setExternalContact, setService, suspendAccount, suspendService, unknown, unsuspendAccount, unsuspendService)
status	string	Task status (cancelled, doing, done, error, todo)
todo_date	string (date-time)	Creation date (wire: todoDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service		Get a task. Returns the function, status, creation date and completion date of the task. The status is todo, doing, done, error or cancelled.
list	select	service	x_pagination_mode	List service tasks. Returns the IDs of the tasks of the MX Plan service. Get one to follow its function, status and dates.

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	Task id
service	string	The internal name of your mxplan organization
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. Returns the function, status, creation date and completion date of the task. The status is todo, doing, done, error or cancelled.

SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.email_mxplan.tasks
WHERE id = '{{ id }}' -- required
AND service = '{{ service }}' -- required
;

list

List service tasks. Returns the IDs of the tasks of the MX Plan service. Get one to follow its function, status and dates.

SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.email_mxplan.tasks
WHERE service = '{{ service }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;