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 parameter
Parameter	Mandatory	Type	Description
task_id	Yes	String	The task ID. Minimum length: 1 character Maximum length: 255 characters

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

Request

**Table 3** Request header parameter
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. Minimum length: 0 characters Maximum length: 255 characters
configurations	Array of ConfigBody objects	The settings of advanced migration options.

**Table 5** **ConfigBody** field description
Parameter	Type	Description
config_key	String	The advanced migration option. The value can be EXCLUDE_MIGRATE_PATH, SYNC_EXCLUDE_PATH, or ONLY_SYNC_PATH. Minimum length: 0 characters Maximum length: 255 characters
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: 404

**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: 1,024 characters

Status code: 500

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

SUCCESS

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