Pause a Synchronization Task
Function
This API is used to pause a synchronization task that is in the synchronizing status. This API is only available in CN North-Beijing4, CN East-Shanghai1, and CN Southwest-Guiyang1.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/sync-tasks/{sync_task_id}/stop
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | The project ID. Minimum: 1 Maximum: 1024 |
| sync_task_id | Yes | String | The synchronization task ID. Minimum: 0 Maximum: 255 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | The token used for IAM authentication. Minimum: 1 Maximum: 16384 |
Response Parameters
Status code: 200
OK
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
Example Requests
This example pauses the synchronization task 0d146099-8cf4-437d-b6ef-88e043771c8b in the project 2c0689c860ad4728a497c91ec0844383.
POST https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/sync-tasks/0d146099-8cf4-437d-b6ef-88e043771c8b Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Forbidden |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
