1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
查询一致性校验任务列表,调用该接口后可通过接口DescribeCompareTasks
查询一致性校验任务列表来获得启动后的状态。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCompareTasks。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
JobId | 是 | String | 迁移任务 Id 示例值:dts-e7ukka6g |
Limit | 否 | Integer | 分页设置,表示每页显示多少条任务,默认为 20 示例值:20 |
Offset | 否 | Integer | 分页偏移量 示例值:0 |
CompareTaskId | 否 | String | 校验任务 ID 示例值:dts-5ftw8366-compare-n0pee6pc |
Status.N | 否 | Array of String | 任务状态过滤,可能的值:created - 创建完成;readyRun - 等待运行;running - 运行中;success - 成功;stopping - 结束中;failed - 失败;canceled - 已终止 示例值:["running"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Items | Array of CompareTaskItem | 一致性校验列表 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询一致性校验任务列表
查询一致性校验任务列表
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCompareTasks
<公共请求参数>
{
"JobId": "dts-e7ukka6g"
}
输出示例
{
"Response": {
"Items": [
{
"CheckProcess": {
"Message": "",
"Status": "",
"StepAll": 0,
"StepNow": 0,
"Percent": 0,
"Steps": []
},
"CompareProcess": {
"Message": "done",
"Status": "",
"StepAll": 0,
"StepNow": 0,
"Steps": []
},
"CompareTaskId": "dts-amm1jw5q-cmp-bmuum7jk",
"Conclusion": "same",
"Config": {
"ObjectItems": [
{
"DbMode": "partial",
"DbName": "big100",
"SchemaName": "",
"TableMode": "partial",
"Tables": null,
"ViewMode": "none",
"Views": null
},
{
"DbMode": "all",
"DbName": "db1",
"SchemaName": "",
"TableMode": "all",
"Tables": null,
"ViewMode": "all",
"Views": null
}
],
"ObjectMode": "partial"
},
"CreatedAt": "2022-07-11 17:21:02",
"FinishedAt": "2022-07-11 17:24:54",
"Method": "dataCheck",
"Options": {
"Method": "dataCheck",
"SampleRate": 100,
"ThreadCount": 1
},
"JobId": "dts-amm1jw5q",
"Message": "done",
"StartedAt": "2022-07-11 17:24:09",
"Status": "success",
"TaskName": "defaultCmpTask"
}
],
"RequestId": "11d35c90-01bb-11ed-bad9-7b3bbe11abda",
"TotalCount": 1
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.AuthFailureError | 认证失败。 |
DryRunOperation.DryRunOperationError | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation.FailedOperationError | 操作失败。 |
InternalError.InternalErrorError | 内部错误。 |
InvalidParameter.InvalidParameterError | 参数无效。 |
InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
LimitExceeded.LimitExceededError | 数量超出限制。 |
MissingParameter.MissingParameterError | 参数丢失。 |
OperationDenied.OperationDeniedError | 操作被拒绝。 |
RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
ResourceInUse.ResourceInUseError | 资源在使用中。 |
ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
ResourceNotFound.BizResourceNotFoundError | 未找到资源。 |
ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
UnknownParameter.UnknownParameterError | 未知参数。 |
UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |