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

Pause a Migration Task

Function

This API is used to pause a migration task in the migrating status.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/tasks/{task_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum: 1

Maximum: 1024

task_id

Yes

Long

The migration task ID.

Minimum: 0

Maximum: 999999999999999

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 task 191297407830872 in the project 2c0689c860ad4728a497c91ec0844383.

POST https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/tasks/191297407830872

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.