Querying the Advanced Migration Options Configured for a Migration Task

Function

This API is used to query the settings of advanced migration options of a task.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The task ID. Minimum length: 1 character Maximum: 36

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
config_key	No	String	The advanced migration options to be queried.

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
task_id	String	The task ID. Minimum length: 0 characters Maximum length: 100 characters
migrate_type	String	The migration method. WINDOWS_MIGRATE_BLOCK: Windows block-level migration LINUX_MIGRATE_FILE: Linux file-level migration LINUX_MIGRATE_BLOCK: Linux block-level migration The value can be: WINDOWS_MIGRATE_BLOCK LINUX_MIGRATE_FILE LINUX_MIGRATE_BLOCK
configurations	Array of ConfigBody objects	The settings of advanced migration options. Array length: 0 to 1,000

**Table 5** ConfigBody
Parameter	Type	Description
config_key	String	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. The value can be: 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	String	The value specified for the advanced migration option. It is stored in the database and parsed on the Agent. Minimum length: 0 characters Maximum length: 1,024 characters
config_status	String	The reserved field that describes the configuration status. Minimum length: 0 characters Maximum length: 255 characters

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	The encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameters. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error details. Array length: 1 to 20

**Table 8** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Example Request

This example obtains the settings of MIGRATE_EXCLUDE_PATH of the task 0867ef5f3xxxxxxxxxxxxxxx.

GET https://{endpoint}/v3/tasks/0867ef5f3xxxxxxxxxxxxxxx/configuration-setting?config_key=MIGRATE_EXCLUDE_PATH

Example Response

Status code: 200

The settings of advanced migration options of a task were queried.

{
  "task_id" : "0867ef5f3xxxxxxxxxxxxxxx",
  "migrate_type" : "LINUX_FILE_MIGRATE",
  "configurations" : [ {
    "config_key" : "MIGRATE_EXCLUDE_PATH",
    "config_value" : "/test",
    "config_status" : ""
  } ]
}

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	The settings of advanced migration options of a task were queried.
400	Bad request.
403	Authentication failed.
404	The task was not found.
500	Querying the settings of advanced migration options failed.