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

Request

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

Table 3 Request body parameters
Parameter	Mandatory	Type	Description
configurations	Yes	Array of ConfigBody objects	The list of advanced migration options. Array length: 0 to 10 characters

Table 4 ConfigBody field description
Parameter	Mandatory	Type	Description
config_key	Yes	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	Yes	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	No	String	The reserved field that describes the configuration status. Minimum length: 0 characters Maximum length: 255 characters

Response

Status code: 404

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

Example Request

This example configures 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 Response

None

Status Codes

Status Code	Description
200	Advanced migration options are configured successfully.
404	The task does not exist.
500	Advanced migration options fail to be configured.

Error Codes

For details, see Error Codes.

Parent topic: Advanced Migration Options Management

Предыдущая статья

Advanced Migration Options Management

Следующая статья

Querying the Settings of Advanced Migration Options of a Task

Была ли эта статья полезна?

Поддержка Юридические документы