Skip to main content

Update Configuration

Interface Overview

Batch update or insert task kv configuration based on task id

Interface Address

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

Request Manner

POST

Request Parameters

The argument is an array, as shown in the following example

[
{
"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
}
]

Each array element is a kv configuration object, the fields of which are described below:

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
dataJobIdTask IDBodyTrueLong
configNameConfiguration NameBodyTrueString
configValueConfiguration Value, please note that parameter items with default values cannot be emptyBodyFalseString
endPointTypeParameter Effect End: SOURCE (source end), TARGET (target end), INDEPENDENT (global)BodyTrueString
configTypeConfiguration Belongs To Entity: SERVER_CORE (task), DATASOURCE (data source), MAPPING (metadata mapping)BodyTrueString
needCreateWhether the configuration has not appeared in this task (new version configuration)BodyFalseString

Public Response Results

ParameterNameParameter DescriptionType(Java)NotNull
code1: Success 0: FailedStringTrue
dataObjectFalse
msgStringFalse
requestIDStringTrue

Response Example

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