Querying the Settings of Advanced Migration Options of a 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	Task ID. Minimum: 1 Maximum: 36

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

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
task_id	String	The task ID. Minimum: 0 Maximum: 100
migrate_type	String	The migration method. WINDOWS_MIGRATE_BLOCK LINUX_MIGRATE_FILE LINUX_MIGRATE_BLOCK Enumeration values: WINDOWS_MIGRATE_BLOCK LINUX_MIGRATE_FILE LINUX_MIGRATE_BLOCK
configurations	Array of ConfigBody objects	The settings of advanced migration options. Array Length: 0 - 1000

**Table 5** ConfigBody
Parameter	Type	Description
config_key	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	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	String	The reserved field that describes the configuration status. Minimum: 0 Maximum: 255

Status code: 400

**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: 1024

Status code: 403

**Table 7** 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 8** 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 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

Status code: 500

**Table 10** 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 queries the setting of MIGRATE_EXCLUDE_PATH of the task 0867ef5f3xxxxxxxxxxxxxxx.

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

Example Responses

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.