Domain name for API request: dts.tencentcloudapi.com
This API is used to cancel a data migration task. This API can be called to cancel a migration task during the migration process. The task will fail once canceled.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter. The value used for this API: StopMigrateJob |
Version | Yes | String | Common parameter. The value used for this API: 2018-03-30 |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
JobId | Yes | String | ID of a data migration task |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.NotAllowOperation | Prohibits the operation. |
InternalError.DatabaseError | Access to the database on the migration platform failed. |
InternalError.DuplicateJob | Migration task conflict. |
InternalError.ProtocolError | Communication protocol error. |
InvalidParameter | Parameter error |
ResourceNotFound.JobNotExist | The migration task does not exist. |
https://dts.tencentcloudapi.com/?Action=StopMigrateJob
&JobId=dts-1kl0iy0v
&<Common request parameters>
{
"Response": {
"RequestId": "22f6b9ca-e94d-4a4d-b48f-a5133e791374"
}
}
Cloud API 3.0 comes with the following development tools to make it easier to call the API.
Was this page helpful?