tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DeleteMigrateJob

最后更新时间：2022-05-12 10:02:19

1. API Description

Domain name for API request: dts.tencentcloudapi.com.

This API (DeleteMigrationJob) is used to delete a data migration task. If the task status queried through the DescribeMigrateJobs API is checking (status=3), running (status=7), ready (status=8), canceling (status=11), or completing (status=12), the task cannot be deleted.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Params. The value used for this API: DeleteMigrateJob.
Version Yes String Common Params. The value used for this API: 2018-03-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
JobId Yes String Data migration task ID

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a data migration task

Input Example

https://dts.tencentcloudapi.com/?Action=DeleteMigrateJob
&JobId=dts-1kl0iy0v
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e15f9b4c-9841-40d2-a28b-dea284a17315"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 This operation is prohibited.
FailedOperation.StatusInConflict This operation cannot be performed due to status conflict.
InternalError An internal error occurred.
InternalError.CeleryError Internal scheduling system error.
InternalError.DatabaseError Failed to access the database on the DTS platform.
InternalError.DuplicateJob Migration tasks are in conflict.
InternalError.ProtocolError Communication protocol error.
InternalError.UndefinedError Internal error.
InternalError.UnknownError Unknown internal error.
InvalidParameter A parameter error occurred.
OperationDenied.JobOperationDeniedError Task operation failure.
OperationDenied.MigrateServiceSupportError DTS does not support the current migration type.
OperationDenied.OperationDenied This operation cannot be performed.
ResourceNotFound.JobNotExist The migration task does not exist.
UnauthorizedOperation.NotEnoughPrivileges Verification failed. Insufficient permissions.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款