platform_tasks

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

Overview

Name	platform_tasks
Type	Resource
Id	ovh.zimbra.platform_tasks

Fields

The following fields are returned by SELECT queries:

list

Asynchronous operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the task
created_at	string (date-time)	Creation date of the task (wire: createdAt)
errors	array	Errors that occurred on the task
finished_at	string (date-time)	Ending date of the task (wire: finishedAt)
link	string	Link to the related resource
message	string	Description of the task
progress	array	Progress steps of the asynchronous operation
started_at	string (date-time)	Starting date of the task (wire: startedAt)
status	string	Current global status of the task (DONE, ERROR, PENDING, RUNNING, SCHEDULED, WAITING_USER_INPUT)
type	string	Type of the task
updated_at	string (date-time)	Last update of the task (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	platform_id	x_pagination_cursor, x_pagination_size, organization_id, organization_label	Returns the tasks of the platform. Filter them by organizationId or organizationLabel.

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"}})
platform_id	string (uuid)	Platform ID (wire: platformId)
organization_id	string (uuid)	Filter by organization identifier (wire: organizationId)
organization_label	string	Filter by organization label (wire: organizationLabel)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the tasks of the platform. Filter them by organizationId or organizationLabel.

SELECT
id,
created_at,
errors,
finished_at,
link,
message,
progress,
started_at,
status,
type,
updated_at
FROM ovh.zimbra.platform_tasks
WHERE platform_id = '{{ platform_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND organization_id = '{{ organization_id }}'
AND organization_label = '{{ organization_label }}'
;