Updated on 2022-08-05 GMT+08:00

Modifying a Migration Project

Function

This API is used to modify a migration project.

URI

PUT /v3/migprojects/{mig_project_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

mig_project_id

Yes

String

Specifies 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

Specifies 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the migration project name.

Minimum length: 0 characters

Maximum length: 255 characters

description

No

String

Describes the migration project.

Minimum length: 0 characters

Maximum length: 255 characters

isdefault

No

Boolean

Specifies whether the migration project is the default project.

Default value: false

region

Yes

String

Specifies the region where the project resides.

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

Specifies 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

Specifies the migration project type.

The value can be:

  • MIGRATE_BLOCK
  • MIGRATE_FILE

enterprise_project

No

String

Specifies 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

Response

None

Example Request

Modify 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

None

Status Codes

Status Code

Description

200

The migration project has been modified successfully.

Error Codes

See Error Codes.