All Products
Search
Document Center

DataWorks:UpdateDIJob

Last Updated:Dec 05, 2024

Updates a synchronization task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DIJobIdlongYes

The ID of the synchronization task.

11588
DescriptionstringNo

The description of the synchronization task.

TableMappingsarray<object>No

The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.

objectNo

The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.

SourceObjectSelectionRulesarray<object>No

The list of rules used to select synchronization objects in the source. The objects can be databases or tables.

objectNo

The rule used to select synchronization objects in the source. The objects can be databases or tables.

ActionstringNo

The operation that is performed to select objects. Valid values: Include and Exclude.

Include
ExpressionstringNo

The expression.

mysql_table_1
ExpressionTypestringNo

The expression type. Valid values: Exact and Regex.

Exact
ObjectTypestringNo

The object type. Valid values:

  • Table
  • Database
Table
TransformationRulesarray<object>No

The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.

objectNo

The transformation rule that you want to apply to the synchronization objects selected from the source.

RuleNamestringNo

The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.

rename_rule_1
RuleActionTypestringNo

The action type. Valid values:

  • DefinePrimaryKey
  • Rename
  • AddColumn
  • HandleDml
Rename
RuleTargetTypestringNo

The type of the object on which you want to perform the action. Valid values:

  • Table
  • Schema
Table
JobSettingsobjectNo

The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.

ChannelSettingsstringNo

The channel control settings for the synchronization task. The value of this parameter must be a JSON string.

{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
ColumnDataTypeSettingsarray<object>No

The data type mappings between source fields and destination fields.

objectNo

The data type mapping between a source field and a destination field.

DestinationDataTypestringNo

The data type of the destination field.

text
SourceDataTypestringNo

The data type of the source field.

bigint
CycleScheduleSettingsobjectNo

The settings for periodic scheduling.

ScheduleParametersstringNo

The scheduling parameters.

bizdate=$bizdate
DdlHandlingSettingsarray<object>No

The processing settings for DDL messages.

objectNo

The processing setting for a specific type of DDL message.

ActionstringNo

The processing policy. Valid values:

  • Ignore: ignores a DDL message.
  • Critical: reports an error for a DDL message.
  • Normal: normally processes a DDL message.
Critical
TypestringNo

The type of the DDL operation. Valid values:

  • RenameColumn
  • ModifyColumn
  • CreateTable
  • TruncateTable
  • DropTable
  • DropColumn
  • AddColumn
AddColumn
RuntimeSettingsarray<object>No

The runtime settings.

objectNo

The runtime setting.

NamestringNo

The name of the configuration item. Valid values:

  • runtime.offline.speed.limit.mb: indicates the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.
  • runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.
  • dst.offline.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.
  • runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.
  • dst.realtime.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.
  • runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.
  • src.offline.datasource.max.connection: indicates the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.
  • runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.
runtime.offline.concurrent
ValuestringNo

The value of the configuration item.

1
ResourceSettingsobjectNo

The resource settings.

OfflineResourceSettingsobjectNo

The resource used for batch synchronization.

RequestedCulongNo

The number of compute units (CUs) in the resource group for Data Integration that are used for batch synchronization.

2.0
ResourceGroupIdentifierstringNo

The identifier of the resource group for Data Integration used for batch synchronization.

S_res_group_111_222
RealtimeResourceSettingsobjectNo

The resource used for real-time synchronization.

RequestedCulongNo

The number of CUs in the resource group for Data Integration that are used for real-time synchronization.

2.0
ResourceGroupIdentifierstringNo

The identifier of the resource group for Data Integration used for real-time synchronization.

S_res_group_111_222
ScheduleResourceSettingsobjectNo

The resource used for scheduling.

RequestedCulongNo

The number of CUs in the resource group for scheduling that are used for batch synchronization.

2.0
ResourceGroupIdentifierstringNo

The identifier of the resource group for scheduling used for batch synchronization.

S_res_group_235454102432001_1721021993437
TransformationRulesarray<object>No

The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.

objectNo

The transformation rule for objects involved in the synchronization task.

RuleActionTypestringNo

The action type. Valid values:

  • DefinePrimaryKey
  • Rename
  • AddColumn
  • HandleDml
Rename
RuleExpressionstringNo

The expression of the rule. The expression must be a JSON string.

Example of a renaming rule: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":[{"variableName":"srcDatabaseName","variableRules":[{"from":"fromdb","to":"todb"}]}]}.

expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} indicates the name of the source. ${srcDatabaseName} indicates the name of a source database. ${srcTableName} indicates the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. The variable name cannot be enclosed in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from specifies the original string. to specifies the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.

If you do not configure such a rule, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that you want to add. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation. Example of a rule used to specify primary key fields for a destination table: {"columns":["ukcolumn1","ukcolumn2"]}.

If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default. If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. Example of a rule used to process DML messages: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.

If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal. dmlType: the DML operation. Valid values: Insert, Update, and Delete. dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.

{"expression":"${srcDatasoureName}_${srcDatabaseName}"}
RuleNamestringNo

The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.

rename_rule_1
RuleTargetTypestringNo

The type of the object on which you want to perform the action. Valid values:

  • Table
  • Schema
Table

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

AAC30B35-820D-5F3E-A42C-E96BB6379325

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "AAC30B35-820D-5F3E-A42C-E96BB6379325"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-14The request parameters of the API has changedView Change Details