Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Task Management/ Cloning a Task
Updated on 2023-11-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Cloning a Task

Function

DRS allows you to clone the configuration of existing synchronization tasks.

Constraints

  • Tasks in the Creating, Creation failed, Configuring, Waiting to start, Starting, or Deleted state cannot be cloned.
  • This API can be used only in certain regions. For details, see Endpoints.

URI

POST /v5/{project_id}/jobs/clone

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of a clone task. The name must start with a letter and can include 4 to 50 characters. It can contain only letters, digits, hyphens (-), and underscores (_). The task name must be unique.

job_id

Yes

String

ID of the task to be cloned.

task_version

No

String

Task version number. The value is 2.0 for new UX tasks. By default, this parameter is left empty, indicating that an old task is cloned.

Enumerated value:

  • 2.0

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

id

String

Task ID.

name

String

Task name.

status

String

Task status.

is_clone_job

String

Indicates whether a task is a clone task.

create_time

String

Task creation time.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Cloning a MySQL synchronization task

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/clone
{
  "job_id": "23fcec7a-899f-40d0-8cd3-7fad453jb201",
  "name": "DRS-8733-copy",
  "task_version": "2.0"
}

Example Response

Status code: 202

Accepted 
{
  "id": "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
  "name": "DRS-1234",
  "status": "CREATING",
  "is_clone_job": true,
  "create_time": "2022-11-07T16:15:18Z"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Error Code

For details, see Error Code.

Parent topic: Task Management