Deleting a Synchronization Task
Function
This API is used to delete a synchronization task.
Tasks being synchronized cannot be deleted. If you try to delete such a task, the system will return a deletion failure. To delete such a task, pause the task first.
Calling Method
For details, see Calling APIs.
URI
DELETE /v2/{project_id}/sync-tasks/{sync_task_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
|
sync_task_id |
Yes |
String |
The synchronization task ID. Minimum length: 0 characters Maximum length: 255 characters |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
OK
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
The error message. |
|
error_code |
String |
The error code. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
The error message. |
|
error_code |
String |
The error code. |
Example Request
This example deletes the synchronization task 0d146099-8cf4-437d-b6ef-88e043771c8b in the 2c0689c860ad4728a497c91ec0844383 project.
DELETE https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/sync-tasks/0d146099-8cf4-437d-b6ef-88e043771c8b
Example Response
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Bad request |
|
403 |
Forbidden |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
