Skip to main content

managed_kubernetes_tasks

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

Overview​

Namemanaged_kubernetes_tasks
TypeResource
Idovh.public_cloud_kubernetes.managed_kubernetes_tasks

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idstring (uuid)Unique identifier of the task
created_atstring (date-time)Creation date of the task (wire: createdAt)
errorsarrayErrors that occurred on the task
finished_atstring (date-time)Ending date of the task (wire: finishedAt)
linkstringLink to the related resource
messagestringDescription of the task
progressarrayProgress steps of the asynchronous operation
started_atstring (date-time)Starting date of the task (wire: startedAt)
statusstringCurrent global status of the task (DONE, ERROR, PENDING, RUNNING, SCHEDULED, WAITING_USER_INPUT)
typestringType of the task
updated_atstring (date-time)Last update of the task (wire: updatedAt)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectmanaged_kubernetes_id, task_id, project_idGet a specific task related to a managed Kubernetes cluster (Beta version)
listselectmanaged_kubernetes_id, project_idx_pagination_cursor, x_pagination_sizeList all tasks related to a managed Kubernetes cluster (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.

NameDatatypeDescription
api_hoststringThe 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"}})
managed_kubernetes_idstring (uuid)Managed kubernetes ID (wire: managedKubernetesId)
project_idstringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
task_idstring (uuid)Task ID (wire: taskId)
x_pagination_cursorstringPagination cursor (wire: X-Pagination-Cursor)
x_pagination_sizeintegerPagination size (wire: X-Pagination-Size)

SELECT examples​

Get a specific task related to a managed Kubernetes cluster (Beta version)

SELECT
id,
created_at,
errors,
finished_at,
link,
message,
progress,
started_at,
status,
type,
updated_at
FROM ovh.public_cloud_kubernetes.managed_kubernetes_tasks
WHERE managed_kubernetes_id = '{{ managed_kubernetes_id }}' -- required
AND task_id = '{{ task_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;