跳到主要内容

查询任务kv配置

接口描述

根据任务id查询其kv配置列表

接口地址

/cloudcanal/console/api/v1/openapi/datajob/listkvconfigsbyjobid

请求方式

POST

请求参数

参数名称参数说明请求类型是否必须数据类型
dataJobId任务idbody是long

公共响应结果

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

data 参数说明

data 是一个数组，其中每一项为一个 kv 配置项信息.其中字段参数如下,需要注意的是

参数名称参数说明不为空数据类型
dataJobIdDataJob id是long
configName配置名称是String
configValue当前配置值否String
defaultValue系统默认值否String
valueRange系统建议值否String
description参数项描述是String
taskType参数所作用的任务类型

BUILD_STRUCT(结构迁移)
FULL(全量迁移)
INCREMENT(增量同步)
CHECK(校验)
REVISE(订正)		否String
endPointType参数作用端

SOURCE(源端)
TARGET(目标端)
INDEPENDENT(全局)		是String
dynamic是否动态变更（无需重启任务）,目前都为 false是boolean
readOnly是否只读是boolean
configType配置所属实体

SERVER_CORE(任务)
DATASOURCE(数据源)
MAPPING(元数据映射)		是String
configTagType配置类型

NORMAL(通用)
PERFORMANCE(性能)		是String
isSecret配置是否是密钥，如果是 true ，则 configValue 为空是boolean
needCreate该配置是否在本任务中未出现(新版本配置)，提交配置更新时需要作为新配置插入是boolean

响应示例

{
  "requestId": "50bcb593-6673-11ed-b716-e934b5005e9f",
  "taskId": 0,
  "workerIdentity": null,
  "sendBackToTask": false,
  "code": "1",
  "msg": "request success",
  "data": [
    {
      "dataJobId": 956,
      "configName": "dataTaskDsType",
      "configValue": "MYSQL_TUNNEL",
      "defaultValue": "",
      "valueRange": "",
      "description": "任务源端和目标端数据源类型组合",
      "taskType": null,
      "endPointType": "INDEPENDENT",
      "dynamic": false,
      "readOnly": true,
      "configType": "SERVER_CORE",
      "configTagType": "NORMAL",
      "needCreate": false,
      "secret": false
    },
    {
      "dataJobId": 956,
      "configName": "specId",
      "configValue": "16",
      "defaultValue": "",
      "valueRange": "15/16/17/18/19/20/21/22/23/24/25/26. 15=1GB mem,16=2GB mem,17=3GB mem,18=4GB mem,19=512MB mem,20=5GB mem,21=6GB mem,22=7GB mem,23=8GB mem,24=12GB mem,25=16GB mem,26=20GB mem.",
      "description": "任务规格ID,必须为配置推荐值",
      "taskType": null,
      "endPointType": "INDEPENDENT",
      "dynamic": false,
      "readOnly": false,
      "configType": "SERVER_CORE",
      "configTagType": "NORMAL",
      "needCreate": false,
      "secret": false
    },
    {
      "dataJobId": 956,
      "configName": "exceptionSkipMode",
      "configValue": "NONE",
      "defaultValue": "NONE",
      "valueRange": "NONE / ApplierHandlerException / ALL",
      "description": "任务异常忽略模式，NONE:不忽略异常,ApplierHandlerException:忽略对端写入异常",
      "taskType": null,
      "endPointType": "INDEPENDENT",
      "dynamic": false,
      "readOnly": false,
      "configType": "SERVER_CORE",
      "configTagType": "NORMAL",
      "needCreate": false,
      "secret": false
    },
    {
      "dataJobId": 956,
      "configName": "ddlExceptionSkip",
      "configValue": "false",
      "defaultValue": "false",
      "valueRange": "true / false",
      "description": "是否忽略对端 DDL 执行异常,true:忽略，false:不忽略 ",
      "taskType": null,
      "endPointType": "INDEPENDENT",
      "dynamic": false,
      "readOnly": false,
      "configType": "SERVER_CORE",
      "configTagType": "NORMAL",
      "needCreate": false,
      "secret": false
    },
    {
      "dataJobId": 956,
      "configName": "fullRingBufferSize",
      "configValue": "64",
      "defaultValue": "16",
      "valueRange": "16-256",
      "description": "全量任务内部队列大小",
      "taskType": null,
      "endPointType": "INDEPENDENT",
      "dynamic": false,
      "readOnly": false,
      "configType": "SERVER_CORE",
      "configTagType": "PERFORMANCE",
      "needCreate": false,
      "secret": false
    },
    {
      "dataJobId": 956,
      "configName": "mappingDef",
      "configValue": "[{\"method\":\"DB_SCHEMA\",\"serializeMapping\":{\"{\\\"value\\\":\\\"dingtax\\\"}\":\"{\\\"parent\\\":{\\\"value\\\":\\\"cc_virtual_db\\\"},\\\"value\\\":\\\"cc_virtual_schema\\\"}\"},\"serializeAutoGenRules\":{},\"commonGenRule\":\"MIRROR\"},{\"serializeMapping\":{},\"method\":\"TABLE_TABLE\",\"serializeAutoGenRules\":{},\"commonGenRule\":\"MIRROR\"},{\"method\":\"COLUMN_COLUMN\",\"serializeMapping\":{},\"serializeAutoGenRules\":{},\"commonGenRule\":\"MIRROR\"}]",
      "defaultValue": "",
      "valueRange": "",
      "description": "表结构映射信息",
      "taskType": null,
      "endPointType": "INDEPENDENT",
      "dynamic": false,
      "readOnly": true,
      "configType": "MAPPING",
      "configTagType": "NORMAL",
      "needCreate": false,
      "secret": false
    },
    {
      ...
    }
  ],
  "fail": false,
  "success": true,
  "rsocketDirectionType": null
}