Updated on 2026-06-30 GMT+08:00

Pause a Migration Task Group with a Specified ID

Function

This API is used to pause a migration task group by ID when the migration task group is in the creating or monitoring status.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/taskgroups/{group_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum: 1

Maximum: 1024

group_id

Yes

String

The task group ID.

Minimum: 1

Maximum: 1024

Request Parameters

Table 2 Request header 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

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

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

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

Example Responses

None

Status Codes

Status Code

Description

200

Ok

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.