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 Parameters
Parameter	Mandatory	Type	Description
mig_project_id	Yes	String	The migration project ID. Minimum: 1 Maximum: 36

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Migration project name. The value can contain only letters, digits, underscores (_), and hyphens (-). 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	No	String	The region name. Minimum: 0 Maximum: 255
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. Minimum: 0 Maximum: 1000
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	No	String	The migration project type. MIGRATE_BLOCK MIGRATE_FILE 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 4** Response body parameters
Parameter	Type	Description
-	String	The default migration project was modified.

Status code: 403

**Table 5** 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 6** 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 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 Responses

Status code: 200

The default migration project was modified.

{ }

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