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

Deleting a Migration Task Group

Function

This API is used to delete a migration task group. Task groups in Creating, Monitoring, or Paused status cannot be deleted. If you try to delete such a task group, the system will return a message indicating the deletion fails. To delete the task group, pause it first.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/taskgroups/{group_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

group_id

Yes

String

The task group ID.

Minimum length: 1 character

Maximum length: 1,024 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_code

String

The error code returned for a migration failure.

Minimum length: 0 characters

Maximum length: 10 characters

error_msg

String

The migration failure cause.

Minimum length: 0 characters

Maximum length: 1,024 characters

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

The error code returned for a migration failure.

Minimum length: 0 characters

Maximum length: 10 characters

error_msg

String

The migration failure cause.

Minimum length: 0 characters

Maximum length: 1,024 characters

Example Request

This example deletes the migration task group 157ece42-3270-4824-a3d2-f0187a03ca01 in the project f4e146cac1de45669c3fed73dc3b9c6f.

DELETE https://{endpoint}/v2/f4e146cac1de45669c3fed73dc3b9c6f/taskgroups/157ece42-3270-4824-a3d2-f0187a03ca01

Example Response

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

Error Codes

For details, see Error Codes.

Parent Topic: Migration Task Group Management