Skip to main content

Modify DataJob (Full Data/Verification)

API Overview

Modify the subscription of a DataJob. It detects whether the current DataTask is Full Data or Verification.

API Path

/cloudcanal/console/api/v1/openapi/datajob/updatetransferobjectforfull

Request Method

POST

Request Parameters

ParameterDescriptionTypeRequiredData Type
dataJobIdDataJob IDBodyYesLong
structMigrationWhether to perform schema migration, such as table creation, database creation, topic creation, etc.BodyNoBoolean
initialSyncWhether to perform full data migrationBodyNoBoolean
addMappingConfigNewly added metadata mapping. Please refer to Metadata MappingBodyNoString
sourceAddConfigMetadata added to the Source. Please refer to Metadata SchemaBodyNoString
targetAddConfigMetadata added to the Target. Please refer to Metadata SchemaBodyNoString
mappingConfigWithoutAddUpdated metadata mapping, excluding newly added ones. Please refer to Metadata MappingBodyYesString
srcSchemaWithoutAddUpdated source metadata, excluding newly added ones. Please refer to Metadata SchemaBodyYesString
dstSchemaWithoutAddUpdated target metadata, excluding newly added ones. Please refer to Metadata SchemaBodyNoString

Response Parameters

ParameterDescriptionType (Java)Not Null
code1: Success; 0: FailStringYes
dataObjectNo
msgStringNo
requestIDStringYes

Response Example

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