Stop Replication Task
Use this API to stop a specified replication task. Stopped tasks cannot be started again.
Usage Notes
Use this API when a replication task is no longer required and should be ended permanently. A successful API response confirms that the stop request was accepted. To pause a running task temporarily, use Suspend Replication Task instead.
Request URL: /openapi/v1/replication/stop
Request Method: POST
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| replicationId | String | Yes | Replication task ID. | rp-deddhxp65zbp |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| requestId | String | Request ID. | Jg5h8LAB-jpolcOSnolnc0ALdnln0RXL |
| message | String | Message returned when the request fails. | replication rp-xxx not found |
Successful Invocation Example
{
"success": true,
"requestId": "Jg5h8LAB-jpolcOSnolnc0ALdnln0RXL"
}
Result
A successful response confirms that the replication task has been stopped. Stopped tasks cannot be started again.