一类节点--数据传输服务dts-查询DTS任务的子任务执行详情
接口功能介绍
查询DTS任务的子任务执行详情，包括预检查、库表结构迁移或初始化、全量迁移或初始化、增量迁移或同步。
接口约束
无
URI
GET /dts/v1/open-api/instance/query-sub-job
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 否 | String | 实例Id说明：1、jobld和prodlnstld至少填写一个;2、jobld和prodlnstld都存在时，以prodlnstld为准 | 846088547620576055 | |
| jobId | 否 | Integer | 任务id说明：1、jobld和prodlnstld至少填写一个;2、jobld和prodlnstld都存在时，以prodlnstld为准 | 1 | |
| subJobCode | 是 | String | 子任务编码，取值：预检查：PRECHECK，结构迁移：STRUCTMIG，全量迁移：ALLSYNC，增量同步：INCSYNC | PRECHECK |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | Integer | 返回码 | 0 | ||
| error | String | 错误码，格式为：DTS_{statusCode} | DTS_9999 | ||
| message | String | 返回消息 | 成功 | ||
| returnObj | Object | 返回信息 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| preCheckItemResult | Object | 预检查子任务详情 | preCheckItemResult | ||
| structMigItemList | Array of Objects | 结构迁移子任务详情 | structMigItemList | ||
| allSyncItemList | Array of Objects | 全量迁移子任务详情 | allSyncItemList | ||
| incSyncItemList | Array of Objects | 增量同步子任务详情 | incSyncItemList |
表 preCheckItemResult
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| preCheckItemList | Array of Objects | 正向预检查 | preCheckItemList | ||
| oppositePreCheckItemList | Array of Objects | 反向预检查 | preCheckItemList |
表 preCheckItemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| id | Integer | id | 1 | ||
| name | String | 检查项名称 | scheme字符集检查 | ||
| content | String | 检查项具体说明 | 检查待迁移库的字符集设置是否在要求范围内 | ||
| result | Integer | 检查结果 | 0 | ||
| message | String | 检查结果具体说明 | '' | ||
| solution | String | 检查项不通过时的解决方案 | '' |
表 structMigItemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| objSrcDbName | String | 结构迁移对象所在源库schema，如数据库名 | sx_test1 | ||
| objTgtDbName | String | 结构迁移对象所在目标库schema，如数据库名 | sx_test | ||
| objName | String | 结构迁移对象，如数据表名 | sx_test | ||
| status | String | 结构迁移状态：0 -> 未开始 1 -> 失败 2 -> 成功 | 2 | ||
| ddl | String | DDL语句 | CREATE TABLE IF NOT EXISTS sx_test1 ( id bigint(20) NOT NULL AUTO_INCREMENT, name varchar(100) COLLATE utf8mb4_bin NOT NULL, address varchar(100) COLLATE utf8mb4_bin DEFAULT NULL, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin |
表 allSyncItemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| objSrcDbName | String | 迁移对象所在源库schema，如数据库名 | sx_test1 | ||
| objTgtDbName | String | 迁移对象所在目标库schema，如数据库名 | sx_test | ||
| objName | String | 迁移对象，如数据表名 | sx_test | ||
| status | String | 全量迁移状态：0 -> 未开始 1 -> 进行中 2 -> 成功 3 -> 失败 | 2 |
表 incSyncItemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| direction | String | FORWARD：正向 REVERSE：反向 | FORWARD | ||
| srcDbName | String | 源库名称 | sx_test | ||
| tgtDbName | String | 目标库名称 | sx_test | ||
| status | Integer | 增量同步状态： 0 -> 未开始 1 -> 有延迟 2 -> 无延迟 | 2 | ||
| delay | Integer | 延迟时间，单位：毫秒 | 0 | ||
| curPos | String | 当前位点 binlog模式：显示位点 gtid模式：显示gtid值 | 06740068-ca14-11ed-ae30-000000f0aef3:1-3691257 | ||
| dstPos | String | 目标位点 binlog模式：显示位点 gtid模式：显示gtid值 | 06740068-ca14-11ed-ae30-000000f0aef3:1-3691257 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "成功",
"returnObj": {
"preCheckItemResult": null,
"structMigItemList": [
{
"objName": "sx_test1",
"objSrcDbName": "sx_test",
"objTgtDbName": "sx_test",
"structStatus": "2",
"ddl": "CREATE TABLE IF NOT EXISTS `sx_test1` (\n `id` bigint(20) NOT NULL AUTO_INCREMENT,
\n `name` varchar(100) COLLATE utf8mb4_bin NOT NULL,
\n `address` varchar(100) COLLATE utf8mb4_bin DEFAULT NULL,
\n PRIMARY KEY (`id`)\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin"
}
],
"allSyncItemList": null,
"incSyncItemList": null
},
"error": ""
}
