managed_kubernetes_tasks
Creates, updates, deletes, gets or lists a managed_kubernetes_tasks resource.
Overview​
| Name | managed_kubernetes_tasks |
| Type | Resource |
| Id | ovh.public_cloud_kubernetes.managed_kubernetes_tasks |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful 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) |
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 |
|---|---|---|---|---|
get | select | managed_kubernetes_id, task_id, project_id | Get a specific task related to a managed Kubernetes cluster (Beta version) | |
list | select | managed_kubernetes_id, project_id | x_pagination_cursor, x_pagination_size | List 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.
| 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"}}) |
managed_kubernetes_id | string (uuid) | Managed kubernetes ID (wire: managedKubernetesId) |
project_id | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
task_id | string (uuid) | Task ID (wire: taskId) |
x_pagination_cursor | string | Pagination cursor (wire: X-Pagination-Cursor) |
x_pagination_size | integer | Pagination size (wire: X-Pagination-Size) |
SELECT examples​
- get
- list
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
;
List all tasks 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 project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;