Performing a Batch Pre-Check¶

Function¶

This API is used to perform batch pre-check to check whether the migration, synchronization, DR can be performed.

Constraints¶

After a task is created, the task status is CONFIGURATION. The task can be invoked only after the test of connections to the source and destination databases is successful and the API for modifying the task is invoked.
In the dual-active DR scenario, when the forward task status is INCRE_TRANSFER_STARTED, the backward task does not need to call this API, and the parent task cannot call this API.

URI¶

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

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	The content type. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM.
X-Language	No	String	Request language type Default value: en-us Values: en-us zh-cn

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
jobs	Yes	Array of PreCheckInfo objects	The list of batch pre-check requests.

**Table 4** PreCheckInfo¶
Parameter	Mandatory	Type	Description
job_id	Yes	String	Task ID.
precheck_mode	Yes	String	Pre-check mode. Value: forStartJob

Response Parameters¶

Status code: 200

**Table 5** Response body parameters¶
Parameter	Type	Description
results	Array of PostPreCheckResp objects	Pre-check response body.
count	Integer	Total number.

**Table 6** PostPreCheckResp¶
Parameter	Type	Description
id	String	Task ID.
precheck_id	String	Pre-check ID.
status	String	Success or failure status. Values: success failed
error_code	String	Error code, which is optional and indicates the returned information about the failure status.
error_msg	String	Error message, which is optional and indicates the returned information about the failure status.

Example Request¶

Example of MySQL pre-check for real-time migration:

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

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

Example Response¶

Status code: 200

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

Status Code¶

Status Code	Description
200	OK
400	Bad Request

Error Code¶

For details, see Error Code.

last updated: 2024-07-26 00:40