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 Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	The migration project name. Minimum: 1 Maximum: 100
description	No	String	The migration project description. Minimum: 0 Maximum: 255
isdefault	No	Boolean	Indicates whether the migration project is the default project. Default: false
region	Yes	String	The region name. Minimum: 0 Maximum: 100
start_target_server	No	Boolean	Indicates whether the target server is started after the migration is complete. Default: true
speed_limit	No	Integer	The migration rate limit, in Mbit/s. 0 indicates no limit. Minimum: 0 Maximum: 1000 Default: 0
use_public_ip	No	Boolean	Indicates whether a public IP address is used for migration. Default: true
exist_server	No	Boolean	Specifies whether an existing server is as the target server. Default: true
type	Yes	String	The migration project type. MIGRATE_BLOCK MIGRATE_FILE Minimum: 0 Maximum: 255 Enumeration values: MIGRATE_BLOCK MIGRATE_FILE
enterprise_project	No	String	The enterprise project name. Default: default Minimum: 0 Maximum: 255
syncing	No	Boolean	Indicates whether continuous synchronization is performed after the first replication or synchronization is complete. Default: false
start_network_check	No	Boolean	Indicates whether network performance measurement is enabled.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	The ID of the newly added migration project. Minimum: 0 Maximum: 255

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 5** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

This API is used to create a migration project. It sets the project name to N121, the region to region, the public IP address to true, and the migration project type to 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 Responses

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."
  } ]
}