Call CancelTask to cancel a data migration task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation uses common request parameters only. For more information, see Common parameters.

Request syntax

POST /openapi/instances/[InstanceId]/actions/cancel-task HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-nif1q9o8r0008****

The ID of the instance.
taskType String Yes MigrateData

The type of the data migration task. Set the value to MigrateData.
clientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.
Result Boolean true

Return results:

  • true: the task was cancelled successfully
  • false: the task was cancelled successfully failed

Examples

Sample requests

POST /openapi/instances/es-cn-nif1q9o8r0008****/actions/cancel-task? taskType=MigrateData HTTP/1.1

Sample success responses

JSON format 

{
    "Result": true,
    "RequestId": "C82758DD-282F-4D48-934F-92170A33****"
}

Error codes

HttpCode Error code Error message Description
400 InstanceNotFound The instanceId provided does not exist. The error message returned because the specified instance cannot be found. Check the instance status.

For a list of error codes, visit the API Error Center.