一类节点--数据传输服务dts-查询DTS任务详情
接口功能介绍
查询DTS数据迁移或者同步任务的详情。
接口约束
无
URI
GET /dts/v1/open-api/instance/query-job
路径参数
无
Query参数
| 参数 |
是否必填 |
参数类型 |
说明 |
示例 |
下级对象 |
| prodInstId |
否 |
String |
实例id说明：1、jobld和prodlnstld至少填写一个；2、jobld和prodlnstld都存在时，以prodlnstld为准 |
846088547620576055 |
|
| jobId |
否 |
Integer |
任务id说明：1、jobld和prodlnstld至少填写一个；2、jobld和prodlnstld都存在时，以prodlnstld为准 |
1 |
|
请求参数
请求头header参数
| 参数 |
是否必填 |
参数类型 |
说明 |
示例 |
下级对象 |
| regionId |
是 |
String |
资源池id |
200000001790 |
|
请求体body参数
无
响应参数
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| statusCode |
Integer |
返回码 |
0 |
|
|
| error |
String |
错误码，格式为：DTS_{statusCode} |
|
|
|
| message |
String |
返回消息 |
成功 |
|
|
| returnObj |
Object |
返回信息 |
|
returnObj |
|
表 returnObj
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| jobId |
Integer |
任务id |
1 |
|
|
| status |
String |
任务状态，UNPRECHECK, PRECHECKING, PRECHECKPASS,MIGRATING,START,INCSTART, STOP, PAUSE, FINISH |
UNPRECHECK |
|
|
| jobConfig |
Object |
任务计划信息，包含任务名，是否增量迁移、全量同步、增量同步 |
|
jobConfig |
|
| dataSourceConfig |
Array of Objects |
源库和目标库信息，size固定为2，子元素需包含数据库类型、角色、连接地址和账号信息 |
|
dataSourceConfig |
|
| objectList |
Array of Objects |
迁移/同步对象的映射组，每一组映射表示源库到目标库的一组对象关联 |
|
objectList |
|
| structProgress |
Integer |
结构迁移进度，0~100之间 |
100 |
|
|
| dataProgress |
Integer |
全量迁移进度，0~100之间 |
100 |
|
|
| incProgress |
Object |
增量同步进度 |
|
incProgress |
|
表 jobConfig
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| name |
String |
任务名 |
test |
|
|
| structMig |
String |
是否开启表结构迁移，可选值true, false |
'true' |
|
|
| allSync |
String |
是否开启全量同步，可选值true, false |
'true' |
|
|
| incSync |
String |
是否开启增量同步，可选值true, false |
'true' |
|
|
| type |
String |
任务类型，可选MIGRATE, SYNC, 分别表示迁移、同步 |
SYNC |
|
|
| startTime |
String |
如果定时开始任务，传入开始时间；否则为空，例如：2023-07-21 00:07:09 |
2023-07-21 00:07:09 |
|
|
| bilateralSync |
Boolean |
是否为双向同步 |
false |
|
|
| mainDirection |
String |
双向同步主方向，FORWARD：正向 REVERSE：反向 |
FORWARD |
|
|
表 objectList
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| from |
Object |
源端数据对象，表示一个TABLE, VIEW, PROCEDURE, FUNCTION, EVENT, TRIGGER的完整信息 |
|
from |
|
| to |
Object |
源端数据对象，表示一个TABLE, VIEW, PROCEDURE, FUNCTION, EVENT, TRIGGER的完整信息 |
|
to |
|
| filter |
String |
过滤条件，默认为空 |
'id>1' |
|
|
| dmlFilter |
Array of Strings |
表示要过滤的dml操作，包含insert、update和delete中的一个或多个，默认为空 |
['delete'] |
|
|
| modifiedColumnNames |
Array of Strings |
变更或删除的字段，示例：假设需要将字段oldName变更成newName，参数为{'old':'oldName','cur':'newName'}，如果是删除该字段，则cur中为空。如果有增量任务，该字段必须为空 |
[{ 'old':'oldName','cur':'newName'}] |
|
|
| wholeDatabase |
String |
表示是否整库同步，可选值'true', 'false'，true表示整库同步，false表示非整库同步，同个schema下的wholeDatabase必须保持一致 |
'true' |
|
|
表 from
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| id |
Integer |
id |
12 |
|
|
| name |
String |
同步对象名称 |
'myTable' |
|
|
| namespace |
String |
同步对象所在数据库schema |
mySchema |
|
|
| type |
String |
同步对象类型：TABLE, VIEW, PROCEDURE, FUNCTION, EVENT, TRIGGER |
TABLE |
|
|
| wholeDatabase |
Boolean |
表示是否整库同步，可选值'true', 'false'，true表示整库同步，false表示非整库同步，同个schema下的wholeDatabase必须保持一致 |
false |
|
|
| isLogicalMedia |
Integer |
是否逻辑表 |
0 |
|
|
| logicMedia |
String |
逻辑表 |
* |
|
|
表 to
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| id |
Integer |
id |
12 |
|
|
| name |
String |
同步对象名称 |
myTable |
|
|
| namespace |
String |
同步对象所在数据库schema |
mySchema |
|
|
| type |
String |
同步对象类型：TABLE, VIEW, PROCEDURE, FUNCTION, EVENT, TRIGGER |
TABLE |
|
|
| wholeDatabase |
Boolean |
表示是否整库同步，可选值'true', 'false'，true表示整库同步，false表示非整库同步，同个schema下的wholeDatabase必须保持一致 |
false |
|
|
| isLogicalMedia |
Integer |
是否逻辑表 |
0 |
|
|
| logicMedia |
String |
逻辑表 |
* |
|
|
表 dataSourceConfig
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| name |
String |
数据库名称 |
|
|
|
| type |
String |
数据库类型，当前针对MySQL，传值为MYSQL |
MYSQL |
|
|
| role |
String |
数据库角色，可选SOURCE, TARGET，SOURCE→单向迁移/同步的源库，TARGET→单向迁移/同步的目标库 |
TARGET |
|
|
| url |
String |
数据库连接地址，IP:Port格式，如127.0.0.1:3306 |
|
|
|
| username |
String |
数据库登录账号 |
|
|
|
| password |
String |
数据库登录密码 |
|
|
|
| isSID |
Boolean |
Oracle是否采用SID方式连接（非Oracle时为空） |
|
|
|
| serviceName |
String |
Oralce登录服务名或SID值（非Oracle时为空） |
|
|
|
| dbName |
String |
pg登录数据库名（非pg时为空） |
|
|
|
表 incProgress
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
|
| status |
Integer |
增量任务状态：0未开始，1有延迟，2无延迟 |
1 |
|
|
| srcDbName |
String |
源库名称 |
test |
|
|
| tgtDbName |
String |
目标库名称 |
test |
|
|
| curPos |
String |
当前位点 |
06740068-ca14-11ed-ae30-000000f0aef3:1-3691257 |
|
|
| dstPos |
String |
目标位点 |
06740068-ca14-11ed-ae30-000000f0aef3:1-3691257 |
|
|
| delay |
Integer |
延迟时间，单位：毫秒 |
1036017980 |
|
|
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":{
"jobId":9,
"status":"INCSTART",
"structProgress":100,
"dataProgress":100,
"incProgress":{
"forward":{
"delay":1033954939,
"status":1
},
"reverse":{
"delay":1051650653,
"status":1
}
},
"jobConfig":{
"allSync":"true",
"incSync":"true",
"structMig":"true",
"bilateralSync":true,
"gmtCreate":"2023-07-11 02: 40: 08",
"type":"SYNC",
"remark":{
"run":false,
"startTime":null,
"endTime":null,
"backupPeriod":null,
"repeat":false,
"syncRecord":null,
"dataMediaPairInspectTimer":null,
"dataMediaPairInspectTimerOn":false,
"autoRepair":false,
"migrationConfig":{
"autoMigrate":false,
"interval":60000,
"syncAll":false,
"pairs":[
]
},
"periodSyncall":false,
"syncallCron":null,
"syncallPairIds":null,
"syncallManualCronExp":null,
"retrySrc":120,
"retryDest":10,
"bilateralSync":true,
"mainDirection":"FORWARD",
"deploymentMode":"REMOTE",
"lowerCase":null
},
"channelId":9
},
"dataSourceConfig":[
{
"id":18,
"name":"data_media_source_4_9_TARGET",
"type":"MYSQL",
"encode":"utf8",
"gmtCreate":1689014408000,
"gmtModified":1689014408000,
"logicalClusterId":"",
"idcId":1,
"idcName":"default machine room2",
"planConfigId":9,
"role":"TARGET",
"url":"",
"username":"root",
"password":"",
"driver":"com.mysql.jdbc.Driver",
"properties":{
},
"isSID":false,
"serviceName":"",
"dbName":"",
"dbInstId":null,
"dbInstName":null,
"useSsl":false,
"certUrl":""
},
{
"id":17,
"name":"data_media_source_4_9_SOURCE",
"type":"MYSQL",
"encode":"utf8",
"gmtCreate":1689014408000,
"gmtModified":1689014408000,
"logicalClusterId":"",
"idcId":1,
"idcName":"default machine room2",
"planConfigId":9,
"role":"SOURCE",
"url":"",
"username":"root",
"password":"",
"driver":"com.mysql.jdbc.Driver",
"properties":{
},
"isSID":false,
"serviceName":"",
"dbName":"",
"dbInstId":null,
"dbInstName":null,
"useSsl":false,
"certUrl":""
}
],
"objectList":[
{
"filter":"",
"dmlFilter":null,
"from":{
"id":53,
"name":"sx_test1",
"namespace":"sx_test",
"type":"TABLE",
"wholeDatabase":false,
"isLogicalMedia":0,
"logicMedia":null
},
"to":{
"id":54,
"name":"sx_test1",
"namespace":"sx_test",
"type":"TABLE",
"wholeDatabase":false,
"isLogicalMedia":0,
"logicMedia":null
},
"columnPair":null
}
]
},
"error":""
}
