migrations
Creates, updates, deletes, gets or lists a migrations resource.
Overview​
| Name | migrations |
| Type | Resource |
| Id | ovh.ovh_cloud_connect.migrations |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Migration reference |
service_id | integer | ServiceId reference (wire: serviceId) |
product_name | string | Name of the migration product (wire: productName) |
creation_date | string (date-time) | Starting date of the migration (wire: creationDate) |
done_date | string (date-time) | Ending date of the migration (wire: doneDate) |
status | string | Migration status (cancelled, doing, done, error, pause, problem, todo) |
type | string | Type of migration (repricing, total) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Returns the migration type (repricing or total), product, status and dates. | |
create | insert | service_name | Starts the migration of the service to its new offer. |
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"}}) |
service_name | string (uuid) | Service name (wire: serviceName) |
SELECT examples​
- get
Returns the migration type (repricing or total), product, status and dates.
SELECT
id,
service_id,
product_name,
creation_date,
done_date,
status,
type
FROM ovh.ovh_cloud_connect.migrations
WHERE service_name = '{{ service_name }}' -- required
;
INSERT examples​
- create
- Manifest
Starts the migration of the service to its new offer.
INSERT INTO ovh.ovh_cloud_connect.migrations (
service_name
)
SELECT
'{{ service_name }}'
;
# Description fields are for documentation purposes
- name: migrations
props:
- name: service_name
value: "{{ service_name }}"
description: Required parameter for the migrations resource.