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: 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 |
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 to use an existing ECS 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 |
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 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
The error code. Minimum length: 0 characters Maximum length: 255 characters |
error_msg |
String |
The error message. Minimum length: 0 characters Maximum length: 255 characters |
encoded_authorization_message |
String |
Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters |
error_param |
Array of strings |
Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20 |
details |
Array of details objects |
The error message. Array length: 1 to 20 |
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" : "default" }
Example Response
Status code: 200
Creating a migration project succeeded.
{ "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001" }
Status code: 403
Authentication failed.
{ "error_code" : "SMS.9004", "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.", "encoded_authorization_message" : "XXXXXX", "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ], "details" : [ { "error_code" : "SMS.9004", "error_msg" : "You do not have permission to perform action XXX on resource XXX." } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Creating a migration project succeeded. |
403 |
Authentication failed. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot