migrations
Creates, updates, deletes, gets or lists a migrations resource.
Overview​
| Name | migrations |
| Type | Resource |
| Id | ovh.me.migrations |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Migration Id |
from | string | Billing country to migrate from (CZ, DE, ES, EU, FI, FR, GB, IE, IT, LT, MA, NL, PL, PT, SN, TN) |
status | string | Migration status (CANCELED, CHECKED, DOING, MIGRATED, TODO, TO_CHECK) |
steps | array | Migration steps |
to | string | Billing country to migrate to (CZ, DE, ES, EU, FI, FR, GB, IE, IT, LT, MA, NL, PL, PT, SN, TN) |
Country Migration
| Name | Datatype | Description |
|---|---|---|
id | integer | Migration Id |
from | string | Billing country to migrate from (CZ, DE, ES, EU, FI, FR, GB, IE, IT, LT, MA, NL, PL, PT, SN, TN) |
status | string | Migration status (CANCELED, CHECKED, DOING, MIGRATED, TODO, TO_CHECK) |
steps | array | Migration steps |
to | string | Billing country to migrate to (CZ, DE, ES, EU, FI, FR, GB, IE, IT, LT, MA, NL, PL, PT, SN, TN) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | migration_id | Retrieve information about a country migration (Beta version) | |
list | select | x_pagination_mode | Retrieve all country migrations (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"}}) |
migration_id | integer | Migration ID (wire: migrationId) |
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
Retrieve information about a country migration (Beta version)
SELECT
id,
from,
status,
steps,
to
FROM ovh.me.migrations
WHERE migration_id = '{{ migration_id }}' -- required
;
Retrieve all country migrations (Beta version)
SELECT
id,
from,
status,
steps,
to
FROM ovh.me.migrations
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;