tasks
Creates, updates, deletes, gets or lists a tasks resource.
Overview​
| Name | tasks |
| Type | Resource |
| Id | ovh.ovh_cloud_connect.tasks |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Task id |
resource_id | integer | Reference of the created resource (wire: resourceId) |
function | string | Task function (addDatacenterConfiguration, addDatacenterExtraConfiguration, addPopConfiguration, addVrack, consumePairingKey, delDatacenterConfiguration, delDatacenterExtraConfiguration, delPopConfiguration, deleteCircuit, diagAccessEdge, diagMacs, diagPeering, diagPeeringExtra, diagRoutes, lockInterface, removeVrack, resetEdgeConfiguration, unlockInterface) |
status | string | Task status (denied, doing, done, error, pause, todo) |
OVHcloud Connect Task
| Name | Datatype | Description |
|---|---|---|
id | integer | Task id |
resource_id | integer | Reference of the created resource (wire: resourceId) |
function | string | Task function (addDatacenterConfiguration, addDatacenterExtraConfiguration, addPopConfiguration, addVrack, consumePairingKey, delDatacenterConfiguration, delDatacenterExtraConfiguration, delPopConfiguration, deleteCircuit, diagAccessEdge, diagMacs, diagPeering, diagPeeringExtra, diagRoutes, lockInterface, removeVrack, resetEdgeConfiguration, unlockInterface) |
status | string | Task status (denied, doing, done, error, pause, todo) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, service_name | Returns the task function, status and the ID of the resource it created. | |
list | select | service_name | x_pagination_mode | Returns the IDs of the service's asynchronous operations. |
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 | Id |
service_name | string (uuid) | Service name (wire: serviceName) |
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 the task function, status and the ID of the resource it created.
SELECT
id,
resource_id,
function,
status
FROM ovh.ovh_cloud_connect.tasks
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the IDs of the service's asynchronous operations.
SELECT
id,
resource_id,
function,
status
FROM ovh.ovh_cloud_connect.tasks
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;