查看数据校验任务信息
更新时间：2023-10-12
接口说明
查看指定ID的数据校验任务信息
请求结构
JSON
1GET /v{version}/task/checksum/{dtsCheckId}/detail
2Host: dts.baidubce.com
3Authorization: authorization string请求参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| version | String | 是 | API版本号 | "1" | URL参数 |
| dtsCheckId | String | 是 | 数据校验任务ID | "dtscxxxyyy" | URL参数 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| success | boolean | 是 | 是否成功 | true |
| result | Result | 是 | 返回结果 | result |
Result字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| dtsCheckTask | DtsCheckTask | 是 | dtsCheckTask | dtsCheckTask |
DtsCheckTask字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| assocDtsId | String | 是 | 关联迁移任务ID | dtsmxxyy1234 |
| status | String | 是 | 任务状态 | finished |
| createTime | String | 是 | 创建时间。UTC格式 | 2020-12-10T13: 24: 10Z |
| srcConnection | Connection | 是 | 源端 | srcConnection |
| dstConnection | Connection | 是 | 目标端 | dstConnection |
| schemaMapping | Schema[] | 是 | schemaMapping | schemaMapping |
| errmsg | String | 是 | 执行失败时返回的错误信息, 执行成功时为空字符串 | errmsg |
| granularity | String | 是 | 校验任务的粒度 | dbtb |
| detailConfig | DetailConfig | 是 | 其他详细配置 | detailConfig |
Connection字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceType | String | 否 | 实例类型 | bcerds |
| region | String | 否 | 地域 | bj |
| dbType | String | 否 | 数据库类型 | mysql |
| dbUser | String | 否 | 数据库访问账号 | dts_trans |
| dbPass | String | 否 | 数据库访问密码 | dbPass |
| dbPort | Integer | 否 | 数据库访问端口 | 3306 |
| dbHost | String | 否 | 数据库ip或主机名 | 192.168.1.1 |
| instanceId | String | 否 | 实例ID | rdsmfgdti3d53f5 |
| field_whitelist | String | 否 | 列过滤（白名单） | field_whitelist |
| field_blacklist | String | 否 | 列过滤（黑名单） | field_blacklist |
| supportOnlineDDL | String | 否 | 同步Online DDL | true，false |
| maxRetryTime | String | 否 | 重试时间 | 720 |
| sqlType | String | 否 | 同步语句选择 | I,U,D,Q |
Schema字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| type | String | 否 | 需要传输的对象类型, 取值有: db(库), table(表), view(视图), function(函数), procedure(存储过程) | table |
| src | String | 否 | 源库的schema名称 | test.table_src |
| dst | String | 否 | 目标库的schema名称 | test.table_dst |
| where | String | 否 | where过滤条件 | where |
DetailConfig字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| incrIgnoreType | String | 否 | 特殊DDL过滤 | drop,truncate |
| useAssocDtsTaskConn | String | 是 | 指定是否使用关联迁移任务的连接配置信息，可选值：true/false | true |
请求示例
JSON
1GET /v{version}/task/checksum/{dtsCheckId}/detail
2Host: dts.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 响应示例
JSON
1HTTP/1.1 200 OK
2
3{
4 "success": true,
5 "status": 200,
6 "result": {
7 "dtsCheckTask": {
8 "status": "finished",
9 "createTime": "2022-09-08T03:11:42Z",
10 "srcConnection": {
11 "instanceType": "public",
12 "region": "bj",
13 "dbType": "mysql",
14 "dbUser": "",
15 "dbPass": "",
16 "dbPort": ,
17 "dbHost": "",
18 "instanceId": "",
19 "maxRetryTime": "",
20 "supportOnlineDDL": "",
21 "field_whitelist": "",
22 "field_blacklist": ""
23 },
24 "dstConnection": {
25 "instanceType": "public",
26 "region": "bj",
27 "dbType": "mysql",
28 "dbUser": "",
29 "dbPass": "",
30 "dbPort": ,
31 "dbHost": "",
32 "instanceId": "",
33 "sqlType": "",
34 "maxRetryTime": ""
35 },
36 "schemaMapping": [
37 {
38 "type": "",
39 "src": "",
40 "dst": "",
41 "where": ""
42 }
43 ],
44 "errmsg": "",
45 "granularity": "instance",
46 "detailConfig": {
47 "incrIgnoreType": null,
48 "useAssocDtsTaskConn": "true"
49 },
50 "assocDtsId": "dtsmxxyy1234"
51 }
52 }
53}