文档首页/数据复制服务 DRS/API参考/API v3（不再推广）/公共接口管理/批量预检查 - BatchCheckJobs
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量预检查 - BatchCheckJobs

功能介绍

批量预检查，校验是否可进行迁移、同步或灾备。

调试

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

接口约束

  • 任务创建成功之后，任务状态为CONFIGURATION，并且与源库、目标库测试连接均通过、修改任务接口调用成功后才能调用。
  • 双主灾备时，需要正向任务状态为INCRE_TRANSFER_STARTED时，反向任务不需要调用该接口，父任务不支持调用。
  • 为保证接口调用性能，建议批量调用数量不超过10个。

授权信息

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

URI

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

表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。

precheck_mode

是

String

预检查模式。取值：

  • forStartJob：任务配置中，首次启动时传该值。
  • forRetryJob：任务增量中，编辑对象后预检查，或者任务失败后重试，传该值。
    说明：

    请按照任务对应的状态传值，否则可能导致预检查失败，影响任务启动。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

results

Array of objects

预检查响应体。

详情请参见表6。

count

Integer

总数。

表6 results字段数据结构说明

参数

参数类型

描述

id

String

任务ID。

precheck_id

String

预检查ID。

status

String

成功或失败的状态。取值：

  • success
  • failed

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

MySQL实时迁移任务首次启动预检查

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

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

响应示例

状态码：200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：公共接口管理