跳到主要内容

数据任务列表

接口描述

查询任务列表

接口地址

/cloudcanal/console/api/v1/openapi/datajob/list

请求方式

POST

请求参数

参数名称参数说明请求类型是否必须数据类型
dataJobId任务idbodylong
dataJobNameDataJob 名称,可模糊查询bodystring
dataJobTypeDataJob 类型, 参考 获取任务类型列表bodystring
desc任务描述,可以模糊查询bodystring
sourceInstanceId源端数据源idbodylong
targetInstanceId目标端数据源idbodylong

公共响应结果

参数名称参数说明类型(java)不为空
code1:成功 0:失败string
dataobject
msgstring
requestIdstring

data 参数说明

data 是一个数组,其中每一项为一个 DataJob 的信息,包含其基本信息,以及具体对应的 Task 列表和数据源信息。详见 查询任务 接口查看具体字段信息

响应示例

{
  "requestId": "3cd0d7cc-2cc2-11ec-a410-d707b3e070b8",
  "code": "1",
  "msg": "request success",
  "data": [
    {
      "dataJobId": 517,
      "dataJobName": "canal1v004a007dd",
      "dataJobDesc": "zzzz",
      "userName": "liqiang",
      "dataJobType": "SYNC",
      "dataTaskState": "FULL",
      "currTaskStatus": "RUNNING",
      "sourceDsVO": {
        "id": 61,
        "gmtCreate": "2021-09-10T03:42:39.000+0000",
        "gmtModified": "2021-09-10T03:58:30.000+0000",
        "uid": "4503980488230169",
        "owner": "liqiang",
        "deployType": "SELF_MAINTENANCE",
        "region": "customer",
        "dataSourceType": "MySQL",
        "privateHost": "127.0.0.1:3306",
        "publicHost": "",
        "hostType": "PRIVATE",
        "instanceDesc": "local_source",
        "version": "5.7.27-log",
        "instanceId": "my-6716s8rryux1366",
        "autoCreateAccount": "NOT_CREATE",
        "schemaJson": null,
        "consoleJobId": 0,
        "consoleTaskState": null,
        "accountName": "origin",
        "lifeCycleState": "CREATED",
        "securityType": "USER_PASSWD"
      },
      "targetDsVO": {
        "id": 1,
        "gmtCreate": "2021-03-26T04:07:23.000+0000",
        "gmtModified": "2021-09-14T11:11:39.000+0000",
        "uid": "4503980488230169",
        "owner": "liqiang",
        "deployType": "SELF_MAINTENANCE",
        "region": "customer",
        "dataSourceType": "MySQL",
        "privateHost": "127.0.0.1:4306",
        "publicHost": "",
        "hostType": "PRIVATE",
        "instanceDesc": "local target",
        "version": "5.7.27-log",
        "instanceId": "my-dc1l0m2cfdtrrhq",
        "autoCreateAccount": "NOT_CREATE",
        "schemaJson": null,
        "consoleJobId": 0,
        "consoleTaskState": null,
        "accountName": "root",
        "lifeCycleState": "CREATED",
        "securityType": "USER_PASSWD"
      },
      "sourceSchema": null,
      "targetSchema": null,
      "mappingConfig": null,
      "filterDdl": false,
      "structMigration": false,
      "initialSync": true,
      "shotTermSync": false,
      "shotTermNum": 0,
      "gmtCreated": "2021-10-14T06:20:06.000+0000",
      "dataTasks": [
        {
          "dataTaskId": 1071,
          "gmtCreate": null,
          "gmtModified": null,
          "dataTaskType": "FULL",
          "dataTaskName": "canal1v004a007dd_FULL",
          "dataTaskStatus": "RUNNING",
          "dataJobId": 517,
          "dataJobName": null,
          "filterDdl": false,
          "checkOnce": false,
          "checkPeriod": false,
          "fullPeriod": false,
          "fullPeriodCronExpr": null,
          "checkPeriodCronExpr": null,
          "checkPeriodNum": 0,
          "lastCheckTime": null,
          "fullJvmHeapMb": 0,
          "incrementJvmHeapMb": 0,
          "checkJvmHeapMb": 0,
          "taskPosition": "{\"dataTaskId\":1071,\"gmtCreate\":1634192406000,\"gmtModified\":1634192406000,\"id\":1071,\"totalToTrans\":0,\"trans\":0,\"transPercent\":0.00}",
          "healthLevel": "Unhealthy",
          "workerId": 1,
          "workerIp": "192.168.0.133",
          "clusterId": 1,
          "dataDelayMs": 0,
          "nextFireTime": null,
          "startTriggerTime": "2021-10-14T06:25:34.000+0000",
          "firstHeartbeatSendTime": null
        },
        {
          "dataTaskId": 1072,
          "gmtCreate": null,
          "gmtModified": null,
          "dataTaskType": "INCREMENT",
          "dataTaskName": "canal1v004a007dd_INCREMENT",
          "dataTaskStatus": "INIT",
          "dataJobId": 517,
          "dataJobName": null,
          "filterDdl": false,
          "checkOnce": false,
          "checkPeriod": false,
          "fullPeriod": false,
          "fullPeriodCronExpr": null,
          "checkPeriodCronExpr": null,
          "checkPeriodNum": 0,
          "lastCheckTime": null,
          "fullJvmHeapMb": 0,
          "incrementJvmHeapMb": 0,
          "checkJvmHeapMb": 0,
          "taskPosition": "{\"dataDelayMillis\":0,\"dataTaskId\":1072,\"delayMillis\":4923195,\"filePosition\":0,\"gmtCreate\":1634192406000,\"gmtModified\":1634192406000,\"id\":1072,\"maxPositionTimestamp\":0,\"positionTimestamp\":1634192406589,\"serverId\":0}",
          "healthLevel": "Health",
          "workerId": 1,
          "workerIp": "192.168.0.133",
          "clusterId": 1,
          "dataDelayMs": 0,
          "nextFireTime": null,
          "startTriggerTime": "9999-09-09T02:00:00.000+0000",
          "firstHeartbeatSendTime": null
        }
      ],
      "fsmId": 446,
      "fsmActive": true,
      "consoleJobId": 1094,
      "consoleTaskState": "SUCCESS",
      "childJobs": null,
      "lifeCycleState": "CREATED",
      "srcSchemaLessFormat": null,
      "dstSchemaLessFormat": null,
      "dstDsCaseSensitive": false,
      "haveException": false
    }
  ]
}