跳到主要内容

更新或插入kv配置

接口描述

根据任务id,批量更新或插入任务kv配置

接口地址

/cloudcanal/console/api/v1/openapi/datajob/upsertkvconfigs

请求方式

POST

请求参数

请为参数为一个数组,如下示例

[
{
"configName": "ddlExceptionSkip",
"configType": "SERVER_CORE",
"configValue": "true",
"dataJobId": 956,
"endPointType": "INDEPENDENT",
"needCreate": false
},
{
"configName": "specId",
"configType": "SERVER_CORE",
"configValue": "17",
"dataJobId": 956,
"endPointType": "INDEPENDENT",
"needCreate": false
}
]

每一个数组元素为一个kv配置对象,其中的字段说明如下

参数名称参数说明请求类型是否必须数据类型
dataJobId任务idbodylong
configName配置名称bodystring
configValue配置值,需要注意的是,带默认值的参数项不能为空bodystring
endPointType参数作用端

SOURCE(源端)
TARGET(目标端)
INDEPENDENT(全局)
bodystring
configType配置所属实体

SERVER_CORE(任务)
DATASOURCE(数据源)
MAPPING(元数据映射)
bodystring
needCreate该配置是否在本任务中未出现(新版本配置)bodystring

公共响应结果

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

响应示例

{
"requestId": "c5665d7c-2cb7-11ec-a410-bfd57df2q1ea",
"code": "1",
"msg": "request success",
"data": null
}