Help Center/Server Migration Service/API Reference/API/Advanced Migration Options Management/Configuring Advanced Migration Options
Updated on 2026-01-27 GMT+08:00
View PDF

Configuring Advanced Migration Options

Function

This API is used to configure advanced migration options for a task, for example, specifying the files or paths to be synchronized.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/{task_id}/configuration-setting

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task 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

configurations

Yes

Array of ConfigBody objects

The list of advanced migration options.

Array Length: 0 - 50

Table 4 ConfigBody

Parameter

Mandatory

Type

Description

config_key

Yes

String

The configuration type.

MIGRATE_EXCLUDE_DIR: The directory that will not be migrated.

SYNC_EXCLUDE_DIR: The directory that will not be synchronized.

ONLY_SYNC_DIR: The directory that will be synchronized.

CONSISTENCY_DIR: The directory for consistency verification.

CONSISTENCY_DIR_ILLEGAL: The illegal directory found in consistency verification.

LINUX_BLOCK_COMPRESS_THREAD_NUM: The number of compression threads for Linux block-level migrations.

MIGRATE_DST_IP: The destination IP address of the migration.

LINUX_BLOCK_CACHE_SIZE: Cache size for Linux block-level migrations.

LINUX_CPU_LIMIT: Linux CPU limit.

LINUX_MEM_LIMIT: Linux memory limit.

LINUX_IO_LIMIT: Linux I/O limit.

NUM_PROCESS_MIGRATE: The number of migration processes.

NUM_PROCESS_SYNC: The number of synchronization processes.

CONSISTENCY_RECHECK: The consistency verification recheck.

CONSISTENCY_MODE: The consistency verification mode.

DYNAMIC_PORT: The dynamic port.

Enumeration values:

  • MIGRATE_EXCLUDE_DIR

  • SYNC_EXCLUDE_DIR

  • ONLY_SYNC_DIR

  • CONSISTENCY_DIR

  • CONSISTENCY_DIR_ILLEGAL

  • LINUX_BLOCK_COMPRESS_THREAD_NUM

  • MIGRATE_DST_IP

  • LINUX_BLOCK_CACHE_SIZE

  • LINUX_CPU_LIMIT

  • LINUX_MEM_LIMIT

  • LINUX_IO_LIMIT

  • NUM_PROCESS_MIGRATE

  • NUM_PROCESS_SYNC

  • CONSISTENCY_RECHECK

  • CONSISTENCY_MODE

  • DYNAMIC_PORT

config_value

Yes

String

The value specified for the advanced migration option. It is stored in the database and parsed on the Agent.

Minimum: 0

Maximum: 1024

config_status

No

String

The reserved field that describes the configuration status.

Minimum: 0

Maximum: 255

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

-

String

Advanced migration options were configured successfully.

Status code: 403

Table 6 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 7 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

Status code: 404

Table 8 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: 1024

Status code: 500

Table 9 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: 1024

Example Requests

This example sets advanced option LINUX_CPU_LIMIT to 50 for a migration task.

POST https://{endpoint}/v3/tasks/{task_id}/configuration-setting

{
  "configurations" : [ {
    "config_key" : "LINUX_CPU_LIMIT",
    "config_value" : 50
  } ]
}

Example Responses

Status code: 200

Advanced migration options were configured successfully.

{ }

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

Status Codes

Status Code

Description

200

Advanced migration options were configured successfully.

403

Authentication failed.

404

The task was not found.

500

Advanced migration options failed to be configured.

Error Codes

See Error Codes.