Updated on 2025-09-16 GMT+08:00

Modifying a Migration Project

Function

This API is used to modify a migration project.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/migprojects/{mig_project_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

mig_project_id

Yes

String

The migration project ID.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

The migration project ID.

Minimum length: 0 characters

Maximum length: 255 characters

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

template

No

TemplateResponseBody object

The template information.

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

The value can be:

  • MIGRATE_BLOCK

  • MIGRATE_FILE

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_network_check

No

Boolean

Indicates whether network performance measurement is enabled.

Table 4 TemplateResponseBody field description

Parameter

Mandatory

Type

Description

id

No

String

The template ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

Yes

String

The template name.

Minimum length: 0 characters

Maximum length: 255 characters

is_template

No

String

Specifies whether the template is general. If the template is associated with a task, the template is not a general template.

Minimum length: 0 characters

Maximum length: 255 characters

region

Yes

String

The region.

Minimum length: 0 characters

Maximum length: 255 characters

projectid

Yes

String

The project ID.

Minimum length: 0 characters

Maximum length: 255 characters

target_server_name

Yes

String

The target server name.

Minimum length: 0 characters

Maximum length: 255 characters

availability_zone

Yes

String

The AZ.

Minimum length: 0 characters

Maximum length: 255 characters

volumetype

Yes

String

The data disk type.

SAS: serial attached SCSI

SSD: solid-state drive

SATA: serial advanced technology attachment

The value can be:

  • SAS

  • SSD

  • SATA

flavor

Yes

String

The server flavor.

Minimum length: 0 characters

Maximum length: 255 characters

vpc

Yes

VpcObject object

The VPC information.

nics

Yes

Array of Nics objects

The NIC information. Multiple NICs are supported. To let the system automatically add a NIC, configure only one NIC entry and set the ID to autoCreate.

Array length: 0 to 65,535

security_groups

Yes

Array of SgObject objects

The security group information. Multiple security groups are supported. To let the system automatically create a security group, configure only one security group record and set the ID to autoCreate.

Array length: 0 to 65,535

publicip

Yes

PublicIp object

The public IP address information.

disk

Yes

Array of TemplateDisk objects

The disk information.

Array length: 0 to 65,535

data_volume_type

Yes

String

The data disk type.

SAS: serial attached SCSI

SSD: solid-state drive

SATA: serial advanced technology attachment

The value can be:

  • SAS

  • SSD

  • SATA

target_password

Yes

String

The target server password.

Minimum length: 0 characters

Maximum length: 1,024 characters

image_id

No

String

The ID of the selected image.

Minimum length: 0 characters

Maximum length: 255 characters

Table 5 VpcObject

Parameter

Mandatory

Type

Description

id

Yes

String

The VPC ID. To let the system automatically create a VPC, set this parameter to autoCreate.

Minimum length: 1 character

Maximum length: 255 characters

name

Yes

String

The VPC name.

Minimum length: 1 character

Maximum length: 255 characters

cidr

No

String

The VPC CIDR block. The default value is 192.168.0.0/16.

Minimum length: 1 character

Maximum length: 255 characters

Table 6 Nics field description

Parameter

Mandatory

Type

Description

id

Yes

String

The subnet ID. To let the system automatically create a subnet, set this parameter to autoCreate.

Minimum length: 0 characters

Maximum length: 255 characters

name

Yes

String

The subnet name.

Minimum length: 0 characters

Maximum length: 255 characters

cidr

Yes

String

The subnet gateway/mask.

Minimum length: 0 characters

Maximum length: 255 characters

ip

No

String

The server IP address. If this parameter is not specified, the system will automatically assign an IP address.

Minimum length: 0 characters

Maximum length: 255 characters

Table 7 SgObject field description

Parameter

Mandatory

Type

Description

id

Yes

String

The security group ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

Yes

String

The security group name.

Minimum length: 0 characters

Maximum length: 255 characters

Table 8 PublicIp field description

Parameter

Mandatory

Type

Description

type

Yes

String

The EIP type. The default value is 5_bgp.

Minimum length: 0 characters

Maximum length: 255 characters

bandwidth_size

Yes

Integer

The bandwidth size in Mbit/s.

The minimum increment for bandwidth adjustment varies depending on the bandwidth range.

The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 to 300 Mbit/s. The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1,000 Mbit/s. The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1,000 Mbit/s.

Minimum value: 1

Maximum value: 2000

bandwidth_share_type

No

String

The bandwidth type, shared or dedicated.

Minimum length: 0 characters

Maximum length: 255 characters

Table 9 TemplateDisk field description

Parameter

Mandatory

Type

Description

id

No

Long

The disk ID.

Minimum value: 0

Maximum value: 9223372036854775807

index

Yes

Integer

The disk index, starting from 0.

Minimum value: 0

Maximum value: 2147483647

name

Yes

String

The disk name.

Minimum length: 0 characters

Maximum length: 255 characters

disktype

Yes

String

The disk type. The value is the same as that of volumetype.

Minimum length: 0 characters

Maximum length: 255 characters

size

Yes

Long

The disk size in GB.

Minimum value: 0

Maximum value: 9223372036854775807

device_use

No

String

The disk usage.

Minimum length: 0 characters

Maximum length: 255 characters

Response

Status code: 200

Table 10 Response body parameter

Parameter

Type

Description

-

String

The default migration project was modified.

Example Request

This example modifies the migration project whose ID is 9879f7aa-3347-47fb-8f89-6070f9e0254e.

PUT  https://{endpoint}/v3/migprojects/9879f7aa-3347-47fb-8f89-6070f9e0254e

{
  "name" : 225,
  "region" : "region",
  "description" : "hello",
  "start_target_server" : true,
  "speed_limit" : 100,
  "use_public_ip" : true,
  "exist_server" : true,
  "type" : "MIGRATE_FILE",
  "syncing" : false
}

Example Response

Status code: 200

The default migration project was modified.

{ }

Status Codes

Status Code

Description

200

The default migration project was modified.

Error Codes

For details, see Error Codes.