tasks
Creates, updates, deletes, gets or lists a tasks resource.
Overview​
| Name | tasks |
| Type | Resource |
| Id | ovh.hosting_web.tasks |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Task's id |
object_id | string | Task object id (wire: objectId) |
done_date | string (date-time) | Done date (wire: doneDate) |
function | string | Task function (abuse/close, abuse/create, abuse/create/web, abuse/delete/web, abuse/update, abuse/update/web, agora/AnycastUpdateReference, agora/DnsAddonUpdateReference, agora/DnsUpdateReference, agora/updateReference, attachedDomain/create, attachedDomain/delete, attachedDomain/restart, attachedDomain/update, cdn/delete, cdn/domain/create, cdn/domain/delete, cdn/domain/flush, cdn/domain/suspend, cdn/flush, cdn/install, cdn/reopen, cdn/suspend, cdn/upgrade, cluster/setDevelopment, cluster/setTesting, cluster/ssl/deploy, cluster/ssl/renew, cluster/test/attachedDomains, cluster/test/cdn, cluster/test/crons, cluster/test/emails, cluster/test/fileBrowser, cluster/test/hostedssl, cluster/test/modules, cluster/test/ovhConfig, cluster/test/userLogs, cluster/test/users, configuration/create, configuration/delete, configuration/update, cron/create, cron/delete, cron/update, database/changePassword, database/changePasswordTest, database/changeRight, database/changeRightTest, database/checkQuotaNow, database/copy, database/copyRestore, database/create, database/delete, database/deleteTest, database/dumpAnyDay, database/hostUpdate, database/import, database/optimize, database/restore, dedicatedIp/delete, dedicatedIp/reopen, dedicatedIp/suspend, depc/push, dump/create, dump/delete, envVar/create, envVar/delete, envVar/update, envVar/upgrade, eventbus/push, filerz/customerMonitoring, filerz/delete, hostedssl/assignFreeKey, hostedssl/cdn/update, hostedssl/create, hostedssl/delete, hostedssl/globalsign/delete, hostedssl/htaccess/install, hostedssl/import, hostedssl/install, hostedssl/install/sectigo, hostedssl/iplb/reload, hostedssl/push, hostedssl/pushDcvFile, hostedssl/regenerate, hostedssl/repush, hosting/activate/privateDatabase, hosting/basculement, hosting/changeOffer/cloud, hosting/changeOffer/shared, hosting/changement, hosting/delete, hosting/delete_start1m, hosting/install, hosting/reopen, hosting/suspend, indy/reopen, indy/suspend, infra/certificate/deploy, infra/certificate/generate, infra/certificate/install, infra/sharedsql/upgrade, infra/ssl/deploy, infra/ssl/renew, ip/move, ip/park, localSeoAccount/create, localSeoAccount/delete, localSeoLocation/delete, localSeoLocation/install, localSeoLocation/reopen, localSeoLocation/suspend, localSeoVisibilityCheck/process, mailsout/checkMailsoutQueue, mailsout/flushMailsoutQueue, mailsout/updateUserInRedis, migration/copyUsers, migration/dday/filerz, migration/dday/listPrivateDatabases, migration/dday/lot, migration/dday/updateInfra/crons, migration/dday/updateInfra/dedicated, migration/dday/updateInfra/migratedFqdn, migration/updateOrt, module/changePassword, module/create, module/delete, module/install, monitoring/remotewrite, notification/send, ovhConfig/refresh, ovhConfig/rollback, ovhConfig/update, ovhOrg/delete, ownLogs/create, ownLogs/delete, provisionning/cdn, provisionning/cluster, provisionning/filerz, provisionning/filerz_log, provisionning/hosting, provisionning/ipfo, provisionning/ipifo, provisionning/iplb, provisionning/privatesql, provisionning/sharedsql, provisionning/ssl, provisionning/web, provisionning/webapp, runtime/create, runtime/delete, runtime/setDefault, runtime/update, scan/create, sqlperso/delete, sqlperso/install, sqlperso/reopen, sqlperso/suspend, synchronizeDepc/attachedDomain, synchronizeDepc/cluster, synchronizeDepc/database, synchronizeDepc/filer, synchronizeDepc/offer, synchronizeDepc/webd, test/migration, user/changePassword, user/create, user/delete, user/update, userLogs/changePassword, userLogs/create, userLogs/delete, uster/setTesting, web/changeDns, web/changeFilerz, web/changeFilerzWithCallback, web/changeJailState, web/changeOutState, web/changeState, web/changeWebState, web/checkQuotaNow, web/create, web/delete, web/deleteUser, web/restoreSnapshot, webProvisionning, webd/changeSlots, website/create, website/delete, website/deploy, website/vcs/create, website/vcs/delete, website/vcs/deploy) |
last_update | string (date-time) | Last update date (wire: lastUpdate) |
object_type | string | Task object type (Abuse, AttachedDomain, BlockedIp, Cdn, Cron, Database, Deployment, Dump, EnvVar, Filerz, Hostedssl, Hosting, Indy, Infra, Minor, Module, Other, OvhConfig, OvhOrg, OwnLogs, Runtime, Scan, Sqlperso, User, UserLogs, Web, Webd, Website) (wire: objectType) |
start_date | string (date-time) | Start date (wire: startDate) |
status | string | Task status (cancelled, doing, done, init, todo) |
Public task
| Name | Datatype | Description |
|---|---|---|
id | integer | Task's id |
object_id | string | Task object id (wire: objectId) |
done_date | string (date-time) | Done date (wire: doneDate) |
function | string | Task function (abuse/close, abuse/create, abuse/create/web, abuse/delete/web, abuse/update, abuse/update/web, agora/AnycastUpdateReference, agora/DnsAddonUpdateReference, agora/DnsUpdateReference, agora/updateReference, attachedDomain/create, attachedDomain/delete, attachedDomain/restart, attachedDomain/update, cdn/delete, cdn/domain/create, cdn/domain/delete, cdn/domain/flush, cdn/domain/suspend, cdn/flush, cdn/install, cdn/reopen, cdn/suspend, cdn/upgrade, cluster/setDevelopment, cluster/setTesting, cluster/ssl/deploy, cluster/ssl/renew, cluster/test/attachedDomains, cluster/test/cdn, cluster/test/crons, cluster/test/emails, cluster/test/fileBrowser, cluster/test/hostedssl, cluster/test/modules, cluster/test/ovhConfig, cluster/test/userLogs, cluster/test/users, configuration/create, configuration/delete, configuration/update, cron/create, cron/delete, cron/update, database/changePassword, database/changePasswordTest, database/changeRight, database/changeRightTest, database/checkQuotaNow, database/copy, database/copyRestore, database/create, database/delete, database/deleteTest, database/dumpAnyDay, database/hostUpdate, database/import, database/optimize, database/restore, dedicatedIp/delete, dedicatedIp/reopen, dedicatedIp/suspend, depc/push, dump/create, dump/delete, envVar/create, envVar/delete, envVar/update, envVar/upgrade, eventbus/push, filerz/customerMonitoring, filerz/delete, hostedssl/assignFreeKey, hostedssl/cdn/update, hostedssl/create, hostedssl/delete, hostedssl/globalsign/delete, hostedssl/htaccess/install, hostedssl/import, hostedssl/install, hostedssl/install/sectigo, hostedssl/iplb/reload, hostedssl/push, hostedssl/pushDcvFile, hostedssl/regenerate, hostedssl/repush, hosting/activate/privateDatabase, hosting/basculement, hosting/changeOffer/cloud, hosting/changeOffer/shared, hosting/changement, hosting/delete, hosting/delete_start1m, hosting/install, hosting/reopen, hosting/suspend, indy/reopen, indy/suspend, infra/certificate/deploy, infra/certificate/generate, infra/certificate/install, infra/sharedsql/upgrade, infra/ssl/deploy, infra/ssl/renew, ip/move, ip/park, localSeoAccount/create, localSeoAccount/delete, localSeoLocation/delete, localSeoLocation/install, localSeoLocation/reopen, localSeoLocation/suspend, localSeoVisibilityCheck/process, mailsout/checkMailsoutQueue, mailsout/flushMailsoutQueue, mailsout/updateUserInRedis, migration/copyUsers, migration/dday/filerz, migration/dday/listPrivateDatabases, migration/dday/lot, migration/dday/updateInfra/crons, migration/dday/updateInfra/dedicated, migration/dday/updateInfra/migratedFqdn, migration/updateOrt, module/changePassword, module/create, module/delete, module/install, monitoring/remotewrite, notification/send, ovhConfig/refresh, ovhConfig/rollback, ovhConfig/update, ovhOrg/delete, ownLogs/create, ownLogs/delete, provisionning/cdn, provisionning/cluster, provisionning/filerz, provisionning/filerz_log, provisionning/hosting, provisionning/ipfo, provisionning/ipifo, provisionning/iplb, provisionning/privatesql, provisionning/sharedsql, provisionning/ssl, provisionning/web, provisionning/webapp, runtime/create, runtime/delete, runtime/setDefault, runtime/update, scan/create, sqlperso/delete, sqlperso/install, sqlperso/reopen, sqlperso/suspend, synchronizeDepc/attachedDomain, synchronizeDepc/cluster, synchronizeDepc/database, synchronizeDepc/filer, synchronizeDepc/offer, synchronizeDepc/webd, test/migration, user/changePassword, user/create, user/delete, user/update, userLogs/changePassword, userLogs/create, userLogs/delete, uster/setTesting, web/changeDns, web/changeFilerz, web/changeFilerzWithCallback, web/changeJailState, web/changeOutState, web/changeState, web/changeWebState, web/checkQuotaNow, web/create, web/delete, web/deleteUser, web/restoreSnapshot, webProvisionning, webd/changeSlots, website/create, website/delete, website/deploy, website/vcs/create, website/vcs/delete, website/vcs/deploy) |
last_update | string (date-time) | Last update date (wire: lastUpdate) |
object_type | string | Task object type (Abuse, AttachedDomain, BlockedIp, Cdn, Cron, Database, Deployment, Dump, EnvVar, Filerz, Hostedssl, Hosting, Indy, Infra, Minor, Module, Other, OvhConfig, OvhOrg, OwnLogs, Runtime, Scan, Sqlperso, User, UserLogs, Web, Webd, Website) (wire: objectType) |
start_date | string (date-time) | Start date (wire: startDate) |
status | string | Task status (cancelled, doing, done, init, 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 function, status and dates of the task. | |
list | select | service_name | function, status, x_pagination_mode | Returns the IDs of the tasks of the hosting. Filter them by function or status. |
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 | Service name (wire: serviceName) |
function | string | Filter tasks by function (like) |
status | string | Filter tasks by status (like) |
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 function, status and dates of the task.
SELECT
id,
object_id,
done_date,
function,
last_update,
object_type,
start_date,
status
FROM ovh.hosting_web.tasks
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the IDs of the tasks of the hosting. Filter them by function or status.
SELECT
id,
object_id,
done_date,
function,
last_update,
object_type,
start_date,
status
FROM ovh.hosting_web.tasks
WHERE service_name = '{{ service_name }}' -- required
AND function = '{{ function }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;