一类节点--数据传输服务dts-查询DTS任务列表及各任务执行详情
接口功能介绍
查询DTS任务列表和各任务的执行状态。
接口约束
无
URI
POST /dts/v1/open-api/instance/list-job
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 否 | String | 实例id | instance1 | |
| jobId | 否 | Integer | 任务id | 1 | |
| jobName | 否 | String | 任务名称，支持模糊匹配 | test | |
| jobType | 是 | String | 任务类型，可选MIGRATE, SYNC, 分别表示迁移、同步 | SYNC | |
| jobStatus | 否 | String | 任务状态，可取值范围如下：UNPRECHECK, PRECHECKING, PRECHECKPASS,MIGRATING,START,INCSTART, STOP, PAUSE, FINISH | UNPRECHECK | |
| srcDataSourceType | 否 | String | 任务中源数据库的类型，目前可取值范围MYSQL,POSTGRESQL | MYSQL | |
| dstDataSourceType | 否 | String | 任务中目标数据库的类型，目前可取值范围MYSQL, POSTGRESQL | MYSQL | |
| pageNo | 否 | Integer | 页码，默认为1 | 1 | |
| pageSize | 否 | Integer | 每页数量，默认20，参数值的范围为5~50 | 20 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | Integer | 返回码 | 0 | ||
| error | String | 错误码，格式为：DTS_{statusCode} | DTS_9999 | ||
| 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 | ||
| pagination | Object | 分页信息 | pagination |
表 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 |
表 dataSourceConfig
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| name | String | 数据库名称 | test | ||
| type | String | 数据库类型，当前针对MySQL，传值为MYSQL | MYSQL | ||
| role | String | 数据库角色，可选SOURCE, TARGET, SOURCE→单向迁移/同步的源库, TARGET→单向迁移/同步的目标库 | TARGET | ||
| url | String | 数据库连接地址，IP:Port格式，如127.0.0.1:3306 | 127.0.0.1:3306 | ||
| username | String | 数据库登录账号 | test | ||
| password | String | 数据库登录密码 | test123 | ||
| isSID | Boolean | Oracle是否采用SID方式连接（非Oracle时为空） | false | ||
| serviceName | String | Oralce登录服务名或SID值（非Oracle时为空） | '' | ||
| dbName | String | pg登录数据库名（非pg时为空） | dbtest |
表 pagination
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 | |
|---|---|---|---|---|---|
| pageNo | Integer | 当前页码 | 1 | ||
| pageSize | Integer | 当前页面数据条数 | 20 | ||
| totalCount | Integer | 数据总条数 | 30 | ||
| totalPageCount | Integer | 总页数 | 2 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"pageNo":1,
"pageSize":10,
"jobType":"SYNC"
}
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":{
"list":[
{
"jobId":15,
"status":"UNPRECHECK",
"jobConfig":{
"allSync":"true",
"incSync":"true",
"structMig":"true",
"bilateralSync":false,
"gmtCreate":"2023-07-25 07: 31: 16",
"type":"SYNC",
"remark":{
"run":false,
"startTime":null,
"endTime":null,
"backupPeriod":null,
"repeat":false,
"syncRecord":null,
"dataMediaPairInspectTimer":null,
"dataMediaPairInspectTimerOn":false,
"autoRepair":false,
"migrationConfig":null,
"periodSyncall":false,
"syncallCron":null,
"syncallPairIds":null,
"syncallManualCronExp":null,
"retrySrc":120,
"retryDest":10,
"bilateralSync":false,
"mainDirection":"FORWARD",
"deploymentMode":null,
"lowerCase":null
},
"channelId":null
},
"dataSourceConfig":[
{
"id":29,
"name":"data_media_source_4_15_SOURCE",
"type":"MYSQL",
"encode":"utf8",
"gmtCreate":1690241476000,
"gmtModified":1690241476000,
"logicalClusterId":"",
"idcId":1,
"idcName":"default machine room2",
"planConfigId":15,
"role":"SOURCE",
"url":"jdbc: mysql: //172.16.4.2: 8854",
"username":"root",
"password":"",
"driver":"com.mysql.jdbc.Driver",
"properties":{
},
"isSID":false,
"serviceName":"",
"dbName":"",
"dbInstId":null,
"dbInstName":null,
"useSsl":false,
"certUrl":""
},
{
"id":30,
"name":"data_media_source_4_15_TARGET",
"type":"MYSQL",
"encode":"utf8",
"gmtCreate":1690241477000,
"gmtModified":1690241477000,
"logicalClusterId":"",
"idcId":1,
"idcName":"default machine room2",
"planConfigId":15,
"role":"TARGET",
"url":"jdbc: mysql: //172.16.4.2: 8843",
"username":"root",
"password":"",
"driver":"com.mysql.jdbc.Driver",
"properties":{
},
"isSID":false,
"serviceName":"",
"dbName":"",
"dbInstId":null,
"dbInstName":null,
"useSsl":false,
"certUrl":""
}
]
}
],
"pagination":{
"pageNo":1,
"pageSize":5,
"totalCount":3,
"totalPageCount":1
}
},
"error":""
}
