Help Center/ Object Storage Migration Service/ API Reference/ APIs V2 (Recommended)/ Synchronization Task Management/ Deleting a Synchronization Task
Updated on 2024-09-12 GMT+08:00
View PDF

Deleting a Synchronization Task

Function

This API is used to delete a synchronization task. In-progress tasks cannot be deleted. If you try to delete an in-progress task, the system will return a message indicating the deletion fails. 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}

Table 1 Path parameters

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

Table 2 Request header parameters

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: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

This example deletes 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.

Parent Topic: Synchronization Task Management