查询DTS校验任务列表
更新时间 2026-06-16 17:04:16
最近更新时间: 2026-06-16 17:04:16
接口功能介绍
查询 DTS 校验任务列表。
接口约束
无
URI
POST /dts/v2/open-api/instance/describeDtsCheckJobs
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageSize | 否 | Integer | 条数 | 20 | |
| pageNumber | 否 | Integer | 当前页码 | 1 | |
| dtsJobId | 否 | Integer | dts任务id | 5678901234567 | |
| dtsJobName | 否 | String | dts任务名称 | Oracle数据实时同步任务 | |
| statusList | 否 | Array of Strings | 状态: | ["RUNNING","FINISH"] | |
| prodManagerOrServiceIp | 否 | String | 管理IP或者业务IP | 192.168.20.36 | |
| tagConfigRelModelList | 否 | Array of Objects | 标签配置 | TagObjectRelModel | |
| groupId | 否 | Integer | 分布式任务的父任务id | 876543210 | |
| jobType | 是 | String | 任务类型,枚举值:ROW_CHECK, DATA_CHECK | DATA_CHECK | |
| sourceEngineType | 否 | String | 源端db类型,枚举值:MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODB | ORACLE | |
| destinationEngineType | 否 | String | 目标端db类型,枚举值:MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODB | UDAL |
表 TagObjectRelModel
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| tagKey | 否 | String | 标签键 | business | |
| tagValue | 否 | String | 标签值 | finance | |
| labelId | 否 | String | 标签id | lab_2026060801 | |
| resourceId | 否 | String | 资源id | dts_job_67890 | |
| resourceType | 否 | String | 资源类型 | DTS_INSTANCE |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| httpStatusCode | Integer | 状态码 | ||
| errCode | String | 错误码 | ||
| errMessage | String | 提示信息 | ||
| success | Boolean | 请求是否成功 | ||
| requestId | String | 请求id | ||
| data | Array of Objects | 响应数据 | CheckJobVO | |
| pageNumber | Integer | 页码 | ||
| pageRecordCount | Integer | 当前页可展示的最大记录数 | ||
| totalRecordCount | Integer | 记录总数 |
表 CheckJobVO
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dtsJobId | Integer | 数据对比任务id | ||
| startTime | String | 开始时间 | ||
| finishTime | String | 结束时间 | ||
| type | String | 任务类型,枚举值:ROW_CHECK, DATA_CHECK | ||
| checkerRatio | Integer | 内容稽查任务抽样率 | ||
| status | String | 任务状态,枚举值:RUNNING, FINISH | ||
| checkStatus | String | 稽查状态,枚举值:CONSISTENT, INCONSISTENT | ||
| totalTableNumber | Integer | 总检查表数量 | ||
| totalFinishTableNumber | Integer | 已检查表数量 | ||
| totalInconsistentTableNumber | Integer | 不一致表数量 | ||
| errorMsg | String | 错误信息 |
枚举参数
无
请求示例
请求url
https://{host}/dts/v2/open-api/instance/describeDtsCheckJobs
请求头header
无
请求体body
{
"groupId": "513",
"jobType": "DATA_CHECK",
"pageIndex": 1,
"pageSize": 10
}
响应示例
{
"httpStatusCode": 200,
"success": true,
"requestId": "00-6a2a8ad0a3d85094a48e83d2638dccaf-863cdc551977396b-00",
"data": [
{
"dtsJobId": 522,
"startTime": "2026-06-11T09:10:43.000+00:00",
"finishTime": "2026-06-11T09:10:48.000+00:00",
"checkerRatio": 5,
"maxDiffCount": 200,
"maxRecheckTime": 3,
"correctData": false,
"multiToOne": false,
"status": "PAUSE",
"checkStatus": "INCONSISTENT",
"totalTableNumber": 0,
"totalFinishTableNumber": 0,
"totalInconsistentTableNumber": 0,
"errorMsg": "DtsRuntimeException: Service Temporarily Unavailable"
},
{
"dtsJobId": 520,
"startTime": "2026-06-11T09:09:55.000+00:00",
"finishTime": "2026-06-11T09:09:57.000+00:00",
"checkerRatio": 5,
"maxDiffCount": 200,
"maxRecheckTime": 3,
"correctData": false,
"multiToOne": false,
"status": "PAUSE",
"checkStatus": "INCONSISTENT",
"totalTableNumber": 0,
"totalFinishTableNumber": 0,
"totalInconsistentTableNumber": 0,
"errorMsg": "DtsRuntimeException: Service Temporarily Unavailable"
},
{
"dtsJobId": 518,
"startTime": "2026-06-11T09:09:06.000+00:00",
"finishTime": "2026-06-11T09:09:11.000+00:00",
"checkerRatio": 5,
"maxDiffCount": 200,
"maxRecheckTime": 3,
"correctData": false,
"multiToOne": false,
"status": "PAUSE",
"checkStatus": "INCONSISTENT",
"totalTableNumber": 0,
"totalFinishTableNumber": 0,
"totalInconsistentTableNumber": 0,
"errorMsg": "DtsRuntimeException: Service Temporarily Unavailable"
},
{
"dtsJobId": 516,
"startTime": "2026-06-11T09:08:17.000+00:00",
"finishTime": "2026-06-11T09:08:19.000+00:00",
"checkerRatio": 5,
"maxDiffCount": 200,
"maxRecheckTime": 3,
"correctData": false,
"multiToOne": false,
"status": "PAUSE",
"checkStatus": "INCONSISTENT",
"totalTableNumber": 0,
"totalFinishTableNumber": 0,
"totalInconsistentTableNumber": 0,
"errorMsg": "DtsRuntimeException: Bad Gateway"
}
],
"pageNumber": 1,
"pageRecordCount": 4,
"totalRecordCount": 4
}
状态码
请参考 状态码
错误码
请参考 错误码