更新时间:2023-09-13 GMT+08:00

批量启动任务

功能介绍

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

调试

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

接口约束

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

取值:

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

参数

是否必选

参数类型

描述

jobs

Array of objects

批量启动任务请求列表。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

job_id

String

任务ID。

start_time

String

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

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

results

Array of StartJobResp objects

批量启动实时灾备任务返回列表。

count

Integer

总数。

表6 StartJobResp

参数

参数类型

描述

id

String

任务ID。

status

String

状态。取值:

  • success
  • failed

order_id

String

订单ID。

说明:

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

error_code

String

错误码。

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

错误码

请参见错误码