1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
本接口用于查询一致性校验任务中,不一致数据块的详情信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCompareDiffItems。 |
| Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| JobId | 是 | String | 迁移任务 Id 示例值:dts-test1234 |
| CompareTaskId | 是 | String | 校验任务 Id 示例值:dts-test1234-cmp-test1234 |
| DBName | 否 | String | 数据库名 示例值:db1 |
| SchemaName | 否 | String | schema名 示例值:schema1 |
| TableName | 否 | String | 数据表名 示例值:tbl1 |
| ChunkId | 否 | Integer | 数据分块号 示例值:1 |
| Limit | 否 | Integer | 分页条件,查询结果返回条数 示例值:10 |
| Offset | 否 | Integer | 分页条件,查询的起始位置 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 查询结果的数量 示例值:10 |
| Items | Array of DiffChunkItem | 查询结果详情 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询不一致数据详情信息
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCompareDiffItems
<公共请求参数>
{
"JobId": "dts-test",
"CompareTaskId": "dts-test-cmp-1234",
"ChunkId": 2,
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"TotalCount": 0,
"Items": [
{
"DBName": "db1",
"TableName": "t1",
"ChunkId": 0,
"Identifier": "pk",
"DiffType": "data",
"SchemaInfo": [
"c1"
],
"SrcItem": [
"value1"
],
"DstItem": [
"value2"
],
"FinishedAt": "2023-12-19 15:54:18"
}
],
"RequestId": "9efd789e-5d6a-4031-b5b8-6d1f031ec614"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。