tasks
Creates, updates, deletes, gets or lists a tasks resource.
Overview​
| Name | tasks |
| Type | Resource |
| Id | ovh.ssl.tasks |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
task_id | integer | Task Id (wire: taskId) |
done_date | string (date-time) | Completion date (wire: doneDate) |
function | string | Task function name (acme_order_certificate, sectigo_deliver_certificate, sectigo_deliver_certificate_from_api, sectigo_order_certificate) |
last_update | string (date-time) | Task last update (wire: lastUpdate) |
start_date | string (date-time) | Task Creation date (wire: startDate) |
status | string | Task status (cancelled, doing, done, error, todo) |
Task on a SSL
| Name | Datatype | Description |
|---|---|---|
task_id | integer | Task Id (wire: taskId) |
done_date | string (date-time) | Completion date (wire: doneDate) |
function | string | Task function name (acme_order_certificate, sectigo_deliver_certificate, sectigo_deliver_certificate_from_api, sectigo_order_certificate) |
last_update | string (date-time) | Task last update (wire: lastUpdate) |
start_date | string (date-time) | Task Creation date (wire: startDate) |
status | string | Task status (cancelled, doing, done, error, todo) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name, task_id | Returns a task of an SSL certificate: function, status (todo, doing, done, error or cancelled), and creation, update and completion dates. | |
list | select | service_name | x_pagination_mode | Returns the identifiers of the tasks of an SSL certificate. |
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 | integer | Task ID (wire: taskId) |
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
- list
Returns a task of an SSL certificate: function, status (todo, doing, done, error or cancelled), and creation, update and completion dates.
SELECT
task_id,
done_date,
function,
last_update,
start_date,
status
FROM ovh.ssl.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;
Returns the identifiers of the tasks of an SSL certificate.
SELECT
task_id,
done_date,
function,
last_update,
start_date,
status
FROM ovh.ssl.tasks
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;