数据传输服务删除一致性校验任务-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： dts.tencentcloudapi.com 。

删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DeleteCompareTask。
Version	是	String	公共参数，本接口取值：2021-12-06。
Region	是	String	公共参数，详见产品支持的地域列表。
JobId	是	String	迁移任务 Id 示例值：dts-8yv4w2i1
CompareTaskId	是	String	对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9 示例值：dts-8yv4w2i1-cmp-37skmii9

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除一致性校验任务

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCompareTask
<公共请求参数>

{
    "JobId": "dts-amm1jw5q",
    "CompareTaskId": "dts-amm1jw5q-cmp-bmuum7jk"
}

输出示例

{
    "Response": {
        "RequestId": "ac300ff0-00f2-11ed-b005-4930e69d89c2"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.AuthFailureError	认证失败。
DryRunOperation.DryRunOperationError	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation.FailedOperationError	操作失败。
InternalError.InternalErrorError	内部错误。
InternalError.UnknownError	未知的内部错误。
InvalidParameter.InvalidParameterError	参数无效。
InvalidParameterValue.InvalidParameterValue	参数值错误。
LimitExceeded.LimitExceededError	数量超出限制。
MissingParameter.MissingParameterError	参数丢失。
OperationDenied.OperationDeniedError	操作被拒绝。
RequestLimitExceeded.RequestLimitExceededError	请求次数超限。
ResourceInUse.ResourceInUseError	资源在使用中。
ResourceInsufficient.ResourceInsufficientError	资源短缺。
ResourceNotFound.ResourceNotFoundError	资源未找到。
ResourceUnavailable.ResourceUnavailableError	资源不可用。
ResourcesSoldOut.ResourcesSoldOutError	资源售罄。
UnauthorizedOperation.UnauthorizedOperationError	未授权的操作。
UnknownParameter.UnknownParameterError	未知参数。
UnsupportedOperation.UnsupportedOperationError	不支持的操作。

删除一致性校验任务

本页目录：