Creating a Migration Project
Function
This API is used to create a migration project.
Constraints
The migration project name must be unique.
Calling Method
For details, see Calling APIs.
URI
POST /v3/migprojects
Request
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 character Maximum length: 16,384 characters |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
name |
Yes |
String |
The migration project name. Minimum length: 2 characters Maximum length: 19 characters |
description |
No |
String |
Describes the migration project. Minimum length: 0 characters Maximum length: 255 characters |
isdefault |
No |
Boolean |
Indicates whether the migration project is the default project. Default value: false |
region |
Yes |
String |
The region name. Minimum length: 0 characters Maximum length: 255 characters |
start_target_server |
No |
Boolean |
Specifies whether to start the target server after the migration. Default value: true |
speed_limit |
No |
Integer |
The migration rate limit, in Mbit/s. Minimum value: 0 Maximum value: 10000 |
use_public_ip |
Yes |
Boolean |
Specifies whether to use a public IP address for migration. Default value: true |
exist_server |
Yes |
Boolean |
Specifies whether to use an existing ECS as the target server. Default value: true |
type |
Yes |
String |
The migration project type. Minimum length: 0 characters Maximum length: 255 characters The value can be: |
enterprise_project |
No |
String |
The enterprise project name. Default value: default Minimum length: 0 characters Maximum length: 255 characters |
syncing |
Yes |
Boolean |
Specifies whether to perform a continuous synchronization after the first replication or synchronization. Default value: false |
start_networck_check |
No |
Boolean |
Whether to measure the network performance. |
Response
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
id |
String |
The ID of the newly added migration project returned after the migration project is created. Minimum length: 0 characters Maximum length: 255 characters |
Example Request
This example creates a migration project. This example creates a migration project by setting the project name to N121, the region to region, the public IP address to true, and the migration project type is MIGRATE_BLOCK.
POST https://{endpoint}/v3/migprojects
{
"name" : "N121",
"description" : "",
"region" : "region",
"start_target_server" : true,
"speed_limit" : 0,
"use_public_ip" : true,
"exist_server" : true,
"isdefault" : true,
"type" : "MIGRATE_BLOCK",
"syncing" : false,
"enterprise_project" : "defalut"
}
Example Response
Status code: 200
OK
{
"id" : "6c6b6a50-6a6a-4d22-bd2c-78455ee5fxxx"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Response returned. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
