更新时间:2023-11-02 GMT+08:00
分享

克隆任务

功能介绍

DRS支持通过克隆功能,快速复制现有同步任务的配置。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

接口约束

  • 对于状态为创建中、创建失败、配置、等待启动、启动中、删除的任务,暂不支持进行克隆。
  • 仅支持部分Region使用,详情参考终端节点

URI

POST /v5/{project_id}/jobs/clone

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

克隆任务名称。名称在4位到50位之间,必须以字母开头,可以包含字母、数字、中划线或下划线,不能包含其他特殊字符,任务名称不能重复。

job_id

String

被克隆任务ID。

task_version

String

任务版本号,新UX任务为2.0。默认为空,即克隆老任务。

枚举值:

  • 2.0

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

id

String

任务ID。

name

String

任务名称。

status

String

任务状态。

is_clone_job

String

是否为克隆任务。

create_time

String

任务创建时间。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

请求示例

克隆MySQL同步任务请求示例。

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

响应示例

状态码: 202

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

状态码: 400

Bad Request

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

错误码

请参见错误码

相关文档