| object | | |
RequestId | string | The request ID. You can use the ID to query logs and troubleshoot issues. | C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490 |
PagingInfo | object | The pagination information. | |
Description | string | The description of the synchronization task. | description |
DestinationDataSourceSettings | array<object> | The properties of the destination. | |
DestinationDataSourceSettings | object | The properties of the destination. | |
DataSourceName | string | The name of the data source. | dw_mysql |
DestinationDataSourceType | string | The destination type. The value Hologres is returned. | Hologres |
JobName | string | The name of the synchronization task. | imp_ods_dms_det_dealer_info_df |
JobSettings | object | | |
ChannelSettings | string | The channel control settings for the synchronization task. The value of this parameter is a JSON string. | {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""} |
ColumnDataTypeSettings | array<object> | The data type mappings between source fields and destination fields. | |
ColumnDataTypeSettings | object | The data type mapping between a source field and a destination field. | |
DestinationDataType | string | The data type of the destination field. | text |
SourceDataType | string | The data type of the source field. | bigint |
CycleScheduleSettings | object | The settings for periodic scheduling. | |
CycleMigrationType | string | The synchronization type that requires periodic scheduling. Valid values:
- Full: full synchronization
- OfflineIncremental: batch incremental synchronization
| Full |
ScheduleParameters | string | The scheduling parameters. | bizdate=$bizdate
|
DdlHandlingSettings | array<object> | The DDL operation types. Valid values:
- RenameColumn
- ModifyColumn
- CreateTable
- TruncateTable
- DropTable
- DropColumn
- AddColumn
| |
DdlHandlingSettings | object | The type of the DDL operation. Valid values:
- RenameColumn
- ModifyColumn
- CreateTable
- TruncateTable
- DropTable
- DropColumn
- AddColumn
| |
Action | string | The processing policy for a specific type of DDL message. Valid values:
- Ignore: ignores a DDL message.
- Critical: reports an error for a DDL message.
- Normal: normally processes a DDL message.
| Ignore |
Type | string | The DDL operation type. Valid values:
- RenameColumn
- ModifyColumn
- CreateTable
- TruncateTable
- DropTable
| CreateTable |
RuntimeSettings | array<object> | | |
RuntimeSettings | object | | |
Name | string | 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
|
Value | string | The value of the configuration item. | 1 |
MigrationType | string | The synchronization type. Valid values:
- FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization
- RealtimeIncremental: real-time incremental synchronization
- Full: full synchronization
- OfflineIncremental: batch incremental synchronization
- FullAndOfflineIncremental: one-time full synchronization and batch incremental synchronization
| FullAndRealtimeIncremental |
ProjectId | long | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.
This parameter indicates the DataWorks workspace to which the API operation is applied. | 98330 |
ResourceSettings | object | | |
OfflineResourceSettings | object | The resource used for batch synchronization. | |
RequestedCu | double | The number of compute units (CUs) in the resource group for scheduling that are used for batch synchronization. | 2.0 |
ResourceGroupIdentifier | string | The identifier of the resource group for Data Integration used for batch synchronization. | S_res_group_7708_1667792816832 |
RealtimeResourceSettings | object | The resource used for real-time synchronization. | |
RequestedCu | double | The number of CUs in the resource group for Data Integration that are used for real-time synchronization. | 2.0 |
ResourceGroupIdentifier | string | The identifier of the resource group for Data Integration used for real-time synchronization. | S_res_group_235454102432001_1579085295030 |
ScheduleResourceSettings | object | The resource used for scheduling. | |
RequestedCu | double | The number of CUs in the resource group for Data Integration that are used for scheduling. | 2.0 |
ResourceGroupIdentifier | string | The identifier of the resource group for scheduling used by the synchronization task. | S_res_group_235454102432001_1718359176885 |
SourceDataSourceSettings | array<object> | The settings of the source. Only a single source is supported. | |
SourceDataSourceSettings | object | The settings of the source. Only a single source is supported. | |
DataSourceName | string | The name of the data source. | dw_mysql |
DataSourceProperties | object | The properties of the data source. | |
Encoding | string | The encoding format of the database. | UTF-8
|
Timezone | string | | GMT+8
|
SourceDataSourceType | string | The source type. The value MySQL is returned. | Mysql |
TableMappings | array<object> | 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. | |
TableMappings | object | The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects. | |
SourceObjectSelectionRules | array<object> | The list of rules used to select synchronization objects in the source. The objects can be databases or tables. | |
SourceObjectSelectionRules | object | The rule used to select synchronization objects in the source. The objects can be databases or tables. | |
Action | string | The operation that is performed to select objects. Valid values: Include and Exclude. | Include |
Expression | string | | mysql_table_1 |
ExpressionType | string | The expression type. Valid values: Exact and Regex. | Exact |
ObjectType | string | The object type. Valid values:
| Table |
TransformationRules | array<object> | The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule. | |
TransformationRuleNames | object | The transformation rule that is applied to the synchronization objects selected from the source. | |
RuleName | string | 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 |
RuleActionType | string | The action type. Valid values:
- DefinePrimaryKey
- Rename
- AddColumn
- HandleDml
| AddColumn |
RuleTargetType | string | The type of the object on which the action is performed. Valid values:
| Table |
TransformationRules | array<object> | The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule. | |
TransformationRules | object | The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule. | |
RuleActionType | string | The action type. Valid values:
- DefinePrimaryKey
- Rename
- AddColumn
- HandleDml
- DefineIncrementalCondition
- DefineCycleScheduleSettings
- DefineRuntimeSettings
- DefinePartitionKey
| Rename |
RuleExpression | string | The expression of the rule. The expression is 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 is not enclosed in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from indicates the original string. to indicates 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 no rule of this type is configured, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that is added. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field. If the value of the columnValueType parameter is Constant, the value of the columnValue parameter is a constant of the STRING data type. If the value of the columnValueType parameter is Variable, the value of the columnValue parameter is 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 indicates the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC indicates the name of the source. TABLE_NAME_SRC indicates the name of a source table. DB_NAME_DEST indicates the name of a destination database. DATASOURCE_NAME_DEST indicates the name of the destination. TABLE_NAME_DEST indicates the name of a destination table. DB_NAME_SRC_TRANSED indicates 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 no rule of this type is configured, 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 no rule of this type is configured, 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. The value Filter is returned for the dmlAction parameter only when the value of the dmlType parameter is Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is returned only when the value of the dmlAction parameter is Filter. | {"expression":"${srcDatasoureName}_${srcDatabaseName}"} |
RuleName | string | 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 |
RuleTargetType | string | The type of the object on which the action is performed. Valid values:
| Table |
DIJobId | string | The ID of the synchronization task. | 32601 |