更新时间:2026-07-29 GMT+08:00

批量启动任务 - BatchStartJobs

功能介绍

批量启动实时迁移、同步、灾备任务。

调试

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

接口约束

  • 需完成所有的任务配置之后,再调用启动任务接口。详情可参考任务创建流程
  • 双主灾备时,需要正向任务状态为INCRE_TRANSFER_STARTED且RPO&RTO小于60s时,反向任务完成所有的任务配置后才能执行该操作,父任务不支持调用。
  • 通过API创建的包年/包月任务,启动时将创建订单并自动支付。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v3/{project_id}/jobs/batch-starting

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的Project ID。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

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

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

X-Auth-Token

String

参数解释

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英语
  • zh-cn:中文

默认取值:

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

Array of objects

参数解释

批量启动任务请求列表,指定需要启动的一个或多个任务。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

job_id

String

参数解释

迁移任务ID,用于唯一标识一个数据复制任务,在查询、修改、删除等操作中作为任务的识别凭证。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_only_init_task

Boolean

参数解释

是否支持只初始化任务,指定启动任务时是否仅执行初始化而不启动数据迁移。

约束限制

  • 仅支持白名单用户使用,需要提交工单申请才能使用。

取值范围

  • true:只初始化任务

  • false:正常启动任务

默认取值

false

start_time

String

参数解释

任务启动时间,指定任务开始执行的时间,时间戳格式精确到毫秒,例如:1608188903063,取值为空代表立即启动。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及,取值为空代表立即启动。

响应参数

状态码:202

表5 响应Body参数

参数

参数类型

描述

results

Array of objects

参数解释

批量启动实时灾备任务返回列表,包含每个任务的启动结果信息。

详情请参见表6

count

Integer

参数解释

返回的任务信息总数,表示本次批量启动操作返回的任务结果数量,与results数组的长度一致。

约束限制

不涉及。

取值范围

不涉及。

表6 StartJobResp

参数

参数类型

描述

id

String

参数解释

迁移任务ID,用于唯一标识一个数据复制任务,在查询、修改、删除等操作中作为任务的识别凭证。

约束限制

不涉及。

取值范围

不涉及。

status

String

参数解释

启动任务的操作状态,表示批量启动任务中单个任务的执行结果。

约束限制

不涉及。

取值范围

  • success:启动成功。
  • failed:启动失败。

order_id

String

参数解释

订单ID。

说明:

通过API创建的包年/包月任务返回该字段。

约束限制

不涉及。

取值范围

不涉及。

error_code

String

参数解释

错误码,当预检查失败时返回的错误代码。

约束限制

不涉及。

取值范围

格式为DRS.XXXXXX。

error_msg

String

参数解释

错误详细信息,当预检查失败时返回的具体错误描述。

约束限制

不涉及。

取值范围

不涉及。

请求示例

批量启动指定实时灾备任务

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-starting

{
  "jobs" : [ {
    "job_id" : "140b5236-88ad-43c8-811c-1268453jb101"
  } ]
}

响应示例

状态码:202

Accepted

{
  "count" : 1,
  "results" : [ {
    "id" : "140b5236-88ad-43c8-811c-1268453jb101",
    "status" : "success"
  } ]
}

状态码

状态码

描述

202

Accepted

400

Bad Request

其他状态请参见状态码

错误码

请参见错误码