接口说明
配置数据校验任务
请求结构
POST /v{version}/task/checksum/{dtsCheckId}/config
Host: dts.baidubce.com
Authorization: authorization string
{
"srcConnection": {
"instanceType": "public",
"region": "bj",
"dbType": "mysql",
"dbUser": "",
"dbPass": "",
"dbPort": ,
"dbHost": "",
"instanceId": "",
"field_whitelist": "",
"field_blacklist": ""
},
"dstConnection": {
"instanceType": "public",
"region": "bj",
"dbType": "mysql",
"dbUser": "",
"dbPass": "",
"dbPort": ,
"dbHost": "",
"instanceId": ""
},
"granularity": "instance",
"detailConfig":{
"useAssocDtsTaskConn":"true",
"recheckTimes": 2,
"recheckIntervalMs": 1,
"batchCount": 2
},
"schemaMapping": []
}
请求参数
| 参数名称 |
参数类型 |
是否必须 |
描述 |
示例值 |
参数位置 |
| version |
String |
是 |
API版本号 |
"1" |
URL参数 |
| dtsCheckId |
String |
是 |
数据校验任务id |
"dtscxxxyyy" |
URL参数 |
| srcConnection |
Connection |
是 |
源端 |
srcConnection |
Request Body 参数 |
| dstConnection |
Connection |
是 |
目标端 |
dstConnection |
Request Body 参数 |
| granularity |
String |
是 |
传输任务的粒度（instance：实例级；dbtb：库表级） |
instance |
Request Body 参数 |
| schemaMapping |
Schema[] |
是 |
granularity为instance实例级别时，schemaMapping传[]即可，如果为库表级别时，不能为空 |
schemaMapping |
Request Body 参数 |
| detailConfig |
DetailConfig |
是 |
detailConfig |
detailConfig |
Request Body 参数 |
Connection字段数据结构说明
| 参数名称 |
参数类型 |
是否必须 |
描述 |
示例值 |
| instanceType |
String |
否 |
实例类型 |
bcerds |
| region |
String |
否 |
地域 |
bj |
| dbType |
String |
否 |
数据库类型 |
mysql |
| dbUser |
String |
否 |
数据库访问账号 |
dts_trans |
| dbPass |
String |
否 |
数据库访问密码 |
dbPort |
| dbPort |
Integer |
否 |
数据库访问端口 |
3306 |
| dbHost |
String |
否 |
数据库ip或主机名 |
192.168.1.1 |
| instanceId |
String |
否 |
实例ID |
rdsmfgdti3d53f5 |
| field_whitelist |
String |
否 |
列过滤（白名单） |
b |
| field_blacklist |
String |
否 |
列过滤（黑名单） |
c |
| 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 |
| checkParallel |
Int |
否 |
并发度，可同时开启的线程数 |
1~32 |
| recheckTimes |
Int |
否 |
数据不一致时重复校验次数 |
1~10 |
| batchCount |
Int |
否 |
最大打包数, 单次抓取数据的条数上限 |
1~5000 |
| bigKeyThreshold |
Int |
否 |
大KEY数据量下限, dbType为redis, redisCluster, openRedisCluster时有效 |
>=1 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 |
参数类型 |
是否必须 |
描述 |
示例值 |
| success |
boolean |
是 |
是否成功 |
true |
| result |
Object |
否 |
暂未使用 |
null |
请求示例
POST /v1/task/checksum/{dtsCheckId}/config
Host: dts.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
{
"srcConnection": {
"instanceType": "public",
"region": "bj",
"dbType": "mysql",
"dbUser": "",
"dbPass": "",
"dbPort": ,
"dbHost": "",
"instanceId": "",
"field_whitelist": "",
"field_blacklist": ""
},
"dstConnection": {
"instanceType": "public",
"region": "bj",
"dbType": "mysql",
"dbUser": "",
"dbPass": "",
"dbPort": ,
"dbHost": "",
"instanceId": ""
},
"granularity": "instance",
"detailConfig":{
"useAssocDtsTaskConn":"true"
},
"schemaMapping": []
}
响应示例
HTTP/1.1 200 OK
{
"success": true,
"result": null
}
