UpdateDIJob API 呼び出しによる同期タスク変更 - DataWorks - Alibaba Cloud - DataWorks

データ統合タスクを更新します。

操作説明

この機能には、DataWorks Basic Edition 以上が必要です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	任意	同期ジョブの ID。	11588
Description	string	任意	同期ジョブの説明。	DI Job Demo
TableMappings	array<object>	任意	オブジェクト変換マッピングのリスト。各マッピングは、ソースオブジェクトの選択ルールセットと、選択されたオブジェクトに適用される変換ルールのリストを指定します。説明 [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]
	array<object>	任意	単一のオブジェクト変換マッピング。ソースオブジェクトの選択ルールセットと、それらのオブジェクトに適用する変換ルールのリストを指定します。
SourceObjectSelectionRules	array<object>	任意	ソースオブジェクトを選択するためのルール。各ルールは、同期するソースデータベースやテーブルなど、異なるタイプのソースオブジェクトを選択できます。
	object	任意	データベースやテーブルなど、同期するソースオブジェクトを選択するためのルール。
Action	string	任意	選択アクション。有効値：`Include` および `Exclude`。	Include
Expression	string	任意	式。	mysql_table_1
ExpressionType	string	任意	式のタイプ。有効値：`Exact` および `Regex`。	Exact
ObjectType	string	任意	オブジェクトタイプ。有効値： `Table` (テーブル) `Schema` (スキーマ) `Database` (データベース)	Table
TransformationRules	array<object>	任意	ソースオブジェクトの変換ルール。
	object	任意	ソースオブジェクトの単一の変換ルール。
RuleName	string	任意	変換ルールの名前。名前は、`RuleActionType` と `RuleTargetType` の特定の組み合わせに対して一意である必要があり、最大 50 文字までです。	rename_rule_1
RuleActionType	string	任意	アクションのタイプ。有効値： `DefinePrimaryKey`：プライマリキーを定義します。 `Rename`：オブジェクトの名前を変更します。 `AddColumn`：列を追加します。 `HandleDml`：DML 操作を処理します。	Rename
RuleTargetType	string	任意	ターゲットオブジェクトのタイプ。有効値： `Table` (テーブル) `Schema` (スキーマ) `Database` (データベース)	Table
JobSettings	object	任意	同期ジョブの設定。これには、DDL 処理設定、ソースとターゲット間の列のデータ型マッピング、および実行時パラメーターが含まれます。
ChannelSettings	string	任意	特定のデータ同期チャネルのジョブ設定。特定のチャネルに特別な設定を適用できます。現在、`Holo2Holo` (Hologres から Hologres への同期) と `Holo2Kafka` (Hologres から Kafka への同期) がサポートされています。 `Holo2Kafka` 例：`{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}` `kafkaClientProperties`：Kafka に書き込む際に使用される Kafka プロデューサーパラメーター。 `keyColumns`：値が Kafka メッセージのキーに書き込まれる列。 `writeMode`：Kafka にデータを書き込むためのフォーマット。有効値：`json` および `canal`。 `Holo2Holo` 例：`{"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}` `conflictMode`：Hologres にデータを書き込む際の競合処理ポリシー。有効値：`replace` (上書き) および `ignore` (無視)。 `writeMode`：Hologres にデータを書き込むためのメソッド。有効値：`replay` および `insert`。 `dynamicColumnAction`：Hologres にデータを書き込む際に動的カラムを処理するためのアクション。有効値：`replay`、`insert`、および `ignore`。	{ "structInfo": "MANAGED", "storageType": "TEXTFILE", "writeMode": "APPEND", "partitionColumns": [ { "columnName": "pt", "columnType": "STRING", "comment": "" } ], "fieldDelimiter": "" }
ColumnDataTypeSettings	array<object>	任意	列データ型マッピングの配列。説明 ["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]
	object	任意	単一の列データ型マッピング。
DestinationDataType	string	任意	ターゲットデータ型。例：`bigint`、`boolean`、`string`、`text`、`datetime`、`timestamp`、`decimal`、`binary`。サポートされるデータ型は、ターゲットデータソースによって異なります。	text
SourceDataType	string	任意	ソースデータ型。例：`bigint`、`boolean`、`string`、`text`、`datetime`、`timestamp`、`decimal`、`binary`。サポートされるデータ型は、ソースデータソースによって異なります。	bigint
CycleScheduleSettings	object	任意	定期スケジューリングの設定。
ScheduleParameters	string	任意	スケジューリングパラメーター。	bizdate=$bizdate
DdlHandlingSettings	array<object>	任意	DDL 処理設定の配列。説明 ["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]
	object	任意	単一の DDL 処理設定。
Action	string	任意	処理アクション。有効値： `Ignore`：DDL メッセージを無視します。 `Critical`：エラーを報告し、同期ジョブを終了します。 `Normal`：DDL メッセージを正常に処理します。	Critical
Type	string	任意	DDL タイプ。有効値： `RenameColumn` `ModifyColumn` `CreateTable` `TruncateTable` `DropTable` `DropColumn` `AddColumn`	AddColumn
RuntimeSettings	array<object>	任意	ランタイム設定。
	object	任意	単一のランタイム設定。
Name	string	任意	設定の名前。有効値： `src.offline.datasource.max.connection`：オフライン同期ジョブのソースへの最大同時接続数。 `dst.offline.truncate`：オフライン同期ジョブの前にターゲットテーブルを切り捨てるかどうかを指定します。 `runtime.offline.speed.limit.enable`：オフライン同期ジョブの速度制限を有効にするかどうかを指定します。 `runtime.offline.concurrent`：オフライン同期ジョブの同時実行レベル。 `runtime.enable.auto.create.schema`：ターゲットでスキーマを自動的に作成するかどうかを指定します。 `runtime.realtime.concurrent`：リアルタイム同期ジョブの同時実行レベル。 `runtime.realtime.failover.minute.dataxcdc`：フェールオーバーリトライの前に待機する分数。 `runtime.realtime.failover.times.dataxcdc`：フェールオーバーリトライの回数。	src.offline.datasource.max.connection
Value	string	任意	設定の値。	1
ResourceSettings	object	任意	リソース設定。
OfflineResourceSettings	object	任意	オフライン同期ジョブのリソース設定。
RequestedCu	number	任意	オフライン同期ジョブで使用されるデータ統合リソースグループの CU 数。	2
ResourceGroupIdentifier	string	任意	オフライン同期ジョブで使用されるデータ統合リソースグループの名前。	S_res_group_111_222
RealtimeResourceSettings	object	任意	リアルタイム同期ジョブのリソース設定。
RequestedCu	number	任意	リアルタイム同期ジョブで使用されるデータ統合リソースグループの CU 数。	2
ResourceGroupIdentifier	string	任意	リアルタイム同期ジョブで使用されるデータ統合リソースグループの名前。	S_res_group_111_222
ScheduleResourceSettings	object	任意	スケジューリングリソース設定。
RequestedCu	number	任意	オフライン同期ジョブで使用されるスケジューリングリソースグループの CU 数。	2
ResourceGroupIdentifier	string	任意	オフライン同期ジョブで使用されるスケジューリングリソースグループの名前。	S_res_group_222_333
TransformationRules	array<object>	任意	変換ルールの定義のリスト。説明 [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
	object	任意	単一の変換ルールの定義。
RuleActionType	string	任意	アクションのタイプ。有効値： `DefinePrimaryKey`：プライマリキーを定義します。 `Rename`：オブジェクトの名前を変更します。 `AddColumn`：列を追加します。 `HandleDml`：DML 操作を処理します。 `DefineIncrementalCondition`：増分条件を定義します。 `DefineCycleScheduleSettings`：定期スケジューリング設定を定義します。 `DefinePartitionKey`：パーティションキーを定義します。	Rename
RuleExpression	string	任意	ルール式。JSON 文字列として指定されます。名前変更ルール (`Rename`) 例：`{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922"}` `expression`：名前変更変換ルールの式。この式は、`$ {srcDatasourceName}` (ソースデータソース名)、`$ {srcDatabaseName}` (ソースデータベース名)、`$ {srcTableName}` (ソーステーブル名) などの変数をサポートします。列追加ルール (`AddColumn`) 例：`{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}` このルールが指定されていない場合、列は追加されません。 `columnName`：追加する列の名前。 `columnValueType`：追加された列の値のタイプ。有効値：`Constant` および `Variable`。 `columnValue`：追加された列の値。`columnValueType` が `Constant` の場合、値は文字列型のカスタム定数です。`columnValueType` が `Variable` の場合、値は組み込み変数です。有効な組み込み変数：`EXECUTE_TIME` (実行時間、Long 型)、`DB_NAME_SRC` (ソースデータベース名、String 型)、`DATASOURCE_NAME_SRC` (ソースデータソース名、String 型)、`TABLE_NAME_SRC` (ソーステーブル名、String 型)、`DB_NAME_DEST` (ターゲットデータベース名、String 型)、`DATASOURCE_NAME_DEST` (ターゲットデータソース名、String 型)、`TABLE_NAME_DEST` (ターゲットテーブル名、String 型)、および `DB_NAME_SRC_TRANSED` (変換後のデータベース名、String 型)。プライマリキー定義ルール (`DefinePrimaryKey`) 例：`{"columns":["ukcolumn1","ukcolumn2"]}` このルールが指定されていない場合、デフォルトでソースのプライマリキーが使用されます。 Data Integration は、既存のターゲットテーブルの構造を変更しません。指定されたプライマリキー列がテーブルに存在しない場合、同期ジョブは失敗します。ターゲットテーブルが自動的に作成されると、Data Integration は定義されたプライマリキー列を構造に含めます。指定されたプライマリキー列がターゲット列セットにない場合、同期ジョブは失敗します。 DML 処理ルール (`HandleDml`) 例：`{"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}` このルールが指定されていない場合、`Insert`、`Update`、および `Delete` 操作のデフォルトのアクションは `Normal` です。 `dmlType`：DML 操作タイプ。有効値：`Insert`、`Update`、および `Delete`。 `dmlAction`：DML 処理ポリシー。有効値：`Normal` (操作を処理)、`Ignore` (操作を無視)、`Filter` (条件付きで操作を処理、`dmlType` が `Update` または `Delete` の場合に使用)、および `LogicalDelete` (論理削除を実行)。 `filterCondition`：DML フィルター条件。`dmlAction` が `Filter` の場合に使用されます。増分条件ルール (`DefineIncrementalCondition`) 例：`{"where":"id > 0"}` 増分条件の `WHERE` 句。定期スケジューリングルール (`DefineCycleScheduleSettings`) 例：`{"cronExpress":" * * * * * *", "cycleType":"1"}` 定期ジョブのスケジューリングパラメーターを指定します。パーティションキー定義ルール (`DefinePartitionKey`) 例：`{"columns":["id"]}` パーティションキーを指定します。	{"expression":"${srcDatasoureName}_${srcDatabaseName}"}
RuleName	string	任意	変換ルールの名前。名前は、`RuleActionType` と `RuleTargetType` の特定の組み合わせに対して一意である必要があり、最大 50 文字までです。	rename_rule_1
RuleTargetType	string	任意	ターゲットオブジェクトのタイプ。有効値： `Table` (テーブル) `Schema` (スキーマ) `Database` (データベース)	Table
ProjectId	integer	任意	DataWorks ワークスペースの ID。ListProjects 操作を呼び出してワークスペース ID を取得できます。	10000
DIJobId `deprecated`	integer	任意	このパラメーターは非推奨です。代わりに `Id` パラメーターを使用してください。	11588
Owner	string	任意	同期ジョブのオーナー。	95279527
FileSpec	string	任意	スクリプトモードでのジョブ設定。	{ "resourceSettings": { "realtimeResourceSettings": { "requestedCu": 2, "resourceGroupIdentifier": "Serverless_res_group_123_456" }, "offlineResourceSettings": { "requestedCu": 2, "resourceGroupIdentifier": "Serverless_res_group_123_456" } }, "tableMappings": [ { "sourceObjectSelectionRules": [ { "expression": "autotest_hologres", "action": "Include", "expressionType": "Exact", "objectType": "Datasource" }, { "expression": "auto_holo_2661647", "action": "Include", "expressionType": "Exact", "objectType": "Table" }, { "expression": "public", "action": "Include", "expressionType": "Exact", "objectType": "Schema" } ], "transformationRules": [ { "ruleTargetType": "Table", "ruleActionType": "SourceSchema", "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe" }, { "ruleTargetType": "Schema", "ruleActionType": "Rename", "ruleName": "Rename_Schema_3qWNOIsljtInvKJy" }, { "ruleTargetType": "Table", "ruleActionType": "Rename", "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW" }, { "ruleTargetType": "Table", "ruleActionType": "DefineDstTableSettings", "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi" }, { "ruleTargetType": "Table", "ruleActionType": "ColumnMapping", "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo" } ] } ], "sourceDataSourceSettings": [ { "dataSourceProperties": { "timeZone": "Asia/Shanghai" }, "dataSourceName": "autotest_hologres" } ], "jobSettings": { "runtimeSettings": [ ], "ddlHandlingSettings": [ ], "columnDataTypeSettings": [ ], "cycleScheduleSettings": { }, "channelSettings": { "destinationChannelSettings": { "conflictMode": "replace", "dynamicColumnAction": "replay", "writeMode": "replay" }, "sourceChannelSettings": { } } }, "destinationDataSourceType": "Hologres", "transformationRules": [ { "ruleTargetType": "Table", "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe", "ruleActionType": "SourceSchema", "ruleExpression": { "columns": [ { "name": "id", "category": "normal", "type": "BIGINT" }, { "name": "decimal", "category": "normal", "type": "DECIMAL" } ] } }, { "ruleTargetType": "Schema", "ruleName": "Rename_Schema_3qWNOIsljtInvKJy", "ruleActionType": "Rename", "ruleExpression": { "expression": "public" } }, { "ruleTargetType": "Table", "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW", "ruleActionType": "Rename", "ruleExpression": { "expression": "auto_holo_2661647_dst" } }, { "ruleTargetType": "Table", "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi", "ruleActionType": "DefineDstTableSettings", "ruleExpression": { "ddlString": "BEGIN; CREATE TABLE IF NOT EXISTS public.auto_holo_2661647_dst ( id BIGINT PRIMARY KEY, "decimal" DECIMAL(38,18) ); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'time_to_live_in_seconds', '3153600000'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'orientation', 'column'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'binlog.level', 'replica'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'binlog.ttl', '2592000'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'bitmap_columns', '"text","char","varchar"'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'dictionary_encoding_columns', '"text":auto,"bytea":auto,"char":auto,"varchar":auto'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'distribution_key', '"id"'); COMMIT; ", "ddlType": "STRUCT" } }, { "ruleTargetType": "Table", "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo", "ruleActionType": "ColumnMapping", "ruleExpression": { "columnMapping": [ { "sourceColName": "id", "dstColName": "id" }, { "sourceColName": "decimal", "dstColName": "decimal" } ] } } ], "migrationType": "FullAndRealtimeIncremental", "destinationDataSourceSettings": [ { "dataSourceProperties": { }, "dataSourceName": "autotest_hologres" } ], "sourceDataSourceType": "Hologres" }

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
Success	boolean	リクエストが成功したかどうかを示します。有効値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
RequestId	string	リクエストの ID。この ID を使用して問題をトラブルシューティングできます。	AAC30B35-820D-5F3E-A42C-E96BB****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。