Skip to main content

Start Replication Task

Use this API to start a specified replication task.

Usage Notes

Call this API after the replication task configuration is finished and the precheck has passed. A successful API response confirms that the start request was accepted. To monitor schema replication, full replication, incremental replication, and delay, call Query Replication Task Status.

Request URL: /openapi/v1/replication/start

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
replicationIdStringYesReplication task ID.rp-deddhxp65zbp

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request was successful.true
requestIdStringRequest ID.Ly6k1KCR-CIHEbMRnHEGv1ZRdBGl2DSN
messageStringMessage returned when the request fails.replication rp-xxx not found

Successful Invocation Example

{
"success": true,
"requestId": "Ly6k1KCR-CIHEbMRnHEGv1ZRdBGl2DSN"
}

Result

A successful response confirms that the replication task has been started.