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 |
X-Auth-Token The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum length: 1 character Maximum length: 16,384 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
The migration project name. Minimum length: 0 characters Maximum length: 255 characters |
|
description |
No |
String |
The migration project description. 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 |
Indicates whether the target server is started after the migration is complete. 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 |
Indicates whether a public IP address is used for migration. Default value: true |
|
exist_server |
Yes |
Boolean |
Specifies whether an existing server is as the target server. Default value: true |
|
type |
Yes |
String |
The migration project type. MIGRATE_BLOCK: block-level migration MIGRATE_FILE: file-level migration 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 |
Indicates whether continuous synchronization is performed after the first replication or synchronization is complete. Default value: false |
|
start_networck_check |
No |
Boolean |
Indicates whether the network performance is measured. |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
The ID of the new migration project returned after the creation is complete. Minimum length: 0 characters Maximum length: 255 characters |
Example Request
This example creates a migration project.
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 |
OK |
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.
