task_accounts
Creates, updates, deletes, gets or lists a task_accounts resource.
Overview​
| Name | task_accounts |
| Type | Resource |
| Id | ovh.email_domain.task_accounts |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Id of task |
name | string | Account name of task |
action | string | Action of task (addAccount, changeAccount, changePassword, deleteAccount, internalMigration, migration, temporaryTask, unknown) |
date | string (date-time) | Creation date of task |
domain | string | Domain name of task |
Task Pop List
| Name | Datatype | Description |
|---|---|---|
id | integer | Id of task |
name | string | Account name of task |
action | string | Action of task (addAccount, changeAccount, changePassword, deleteAccount, internalMigration, migration, temporaryTask, unknown) |
date | string (date-time) | Creation date of task |
domain | string | Domain name of task |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain, id | Get an account task. Returns the action, the account name, the domain and the creation date of the email account task. | |
list | select | domain | name, x_pagination_mode | List account tasks. Returns the IDs of the pending email account tasks of the domain. Filter them by account name. |
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"}}) |
domain | string | Name of your domain name |
id | integer | Id of task |
name | string | Account name |
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
Get an account task. Returns the action, the account name, the domain and the creation date of the email account task.
SELECT
id,
name,
action,
date,
domain
FROM ovh.email_domain.task_accounts
WHERE domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
;
List account tasks. Returns the IDs of the pending email account tasks of the domain. Filter them by account name.
SELECT
id,
name,
action,
date,
domain
FROM ovh.email_domain.task_accounts
WHERE domain = '{{ domain }}' -- required
AND name = '{{ name }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;