Skip to main content

migrations

Creates, updates, deletes, gets or lists a migrations resource.

Overview​

Namemigrations
TypeResource
Idovh.me.migrations

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idintegerMigration Id
fromstringBilling country to migrate from (CZ, DE, ES, EU, FI, FR, GB, IE, IT, LT, MA, NL, PL, PT, SN, TN)
statusstringMigration status (CANCELED, CHECKED, DOING, MIGRATED, TODO, TO_CHECK)
stepsarrayMigration steps
tostringBilling 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:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectmigration_idRetrieve information about a country migration (Beta version)
listselectx_pagination_modeRetrieve 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.

NameDatatypeDescription
api_hoststringThe 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_idintegerMigration ID (wire: migrationId)
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

Retrieve information about a country migration (Beta version)

SELECT
id,
from,
status,
steps,
to
FROM ovh.me.migrations
WHERE migration_id = '{{ migration_id }}' -- required
;