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}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
mig_project_id |
Yes |
String |
The migration project ID. Minimum length: 0 characters Maximum length: 255 characters |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
The migration project ID. Minimum length: 1 character Maximum length: 254 characters |
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 |
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 |
Specifies whether to start the target server after the migration. 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 |
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 |
The migration project type. 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_network_check |
No |
Boolean |
Whether to measure the network performance. |
Response
None
Example Request
This example modifies the information about the migration project whose ID is 9879f7aa-3347-47fb-8f89-6070f9e0xxxx. The new migration project name is 225, the region information is region, the speed limit is 100 Mbit/s, and the migration type is MIGRATE_FILE.
PUT https://{endpoint}/v3/migprojects/9879f7aa-3347-47fb-8f89-6070f9e0xxxx { "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
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.