Start Replication Precheck
Use this API to start the precheck for a specified replication task. The precheck verifies risks such as data source connectivity, account permissions, and object conflicts before the task starts.
Usage Notes
Run the precheck after creating or updating a replication task and before starting the task. A successful API response confirms that the precheck request was accepted. To review the overall precheck status and item-level results, call Query Replication Task Precheck Status.
Request URL: /openapi/v1/replication/precheck/start
Request Method: POST
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| replicationId | String | Yes | Replication task ID. | rp-div1e4z3z3g3 |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| requestId | String | Request ID. | Ez7c1WSZ-cijbiMXnbfgr9HHddkr2QMJ |
| message | String | Message returned when the request fails. | replication rp-xxx not found |
Successful Invocation Example
{
"success": true,
"requestId": "Ez7c1WSZ-cijbiMXnbfgr9HHddkr2QMJ"
}
Result
A successful response confirms that the replication precheck has been started.