Suspend Replication Task
Use this API to suspend a running replication task.
Usage Notes
Use this API when a running replication task needs to be paused temporarily, such as during a maintenance window or short-term source or target troubleshooting. A successful API response confirms that the suspend request was accepted. To confirm the latest task state after the request, call Query Replication Task Status.
Request URL: /openapi/v1/replication/suspend
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. | Pb5r3LOV-ekjgtSYnjgil3VUdgik3PEE |
| message | String | Message returned when the request fails. | replication rp-xxx not found |
Successful Invocation Example
{
"success": true,
"requestId": "Pb5r3LOV-ekjgtSYnjgil3VUdgik3PEE"
}
Result
A successful response confirms that the replication task has been suspended.