すべてのプロダクト
Search
ドキュメントセンター

DataWorks:CreateDIJob

最終更新日:Sep 03, 2026

Data Integration タスクを作成します。

操作説明

  • この機能を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

  • この操作は Data Integration 同期タスクを作成します。パラメーターには、ソース構成 SourceDataSourceSettings と送信先構成 DestinationDataSourceSettings、サポートされる同期タイプ MigrationType、列の追加やテーブル名の変更などのマッピング操作のために TransformationRules で定義された変換ルール、TableMappings で定義された同期対象の特定のテーブルおよび適用するマッピングルール、JobSettings で定義された列マッピングやスケジューリング構成などのタスクレベルの設定が含まれます。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

DestinationDataSourceType

string

任意

送信先データソースのタイプ。有効な値: Hologres、OSS-HDFS、OSS、MaxCompute、LogHub、StarRocks、DataHub、AnalyticDB_For_MySQL、Kafka、Hive。

Hologres

Description

string

任意

タスクの説明。

DI Job Demo

SourceDataSourceType

string

任意

ソースデータソースのタイプ。有効な値: PolarDB、MySQL、Kafka、LogHub、Hologres、Oracle、OceanBase、MongoDB、RedShift、Hive、SQLServer、Doris、ClickHouse。

MySQL

ProjectId

integer

任意

DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース管理ページに移動して ID を取得できます。

このパラメーターは、この API 呼び出しの DataWorks ワークスペースを指定します。

10000

Name

string

任意

タスクの名前。

mysql_to_holo_sync_8772

MigrationType

string

任意

同期タイプ。有効な値:

  • FullAndRealtimeIncremental: データベース全体のフルおよびリアルタイム増分同期。

  • RealtimeIncremental: 単一テーブルのリアルタイム増分同期。

  • Full: データベース全体のオフラインフル同期。

  • OfflineIncremental: データベース全体のオフライン増分同期。

  • FullAndOfflineIncremental: データベース全体のオフラインフルおよびオフライン増分同期。

FullAndRealtimeIncremental

JobType

string

任意

タスクタイプ。有効な値:

  • DatabaseRealtimeMigration: データベース全体のリアルタイム移行。複数のソースデータベースから複数のテーブルのストリーミング同期を実行します。フルのみ、増分のみ、またはフルおよび増分同期をサポートします。

  • DatabaseOfflineMigration: データベース全体のオフライン移行。複数のソースデータベースから複数のテーブルのバッチ同期を実行します。フルのみ、増分のみ、またはフルおよび増分同期をサポートします。

  • SingleTableRealtimeMigration: 単一テーブルのリアルタイム移行。単一のソーステーブルのストリーミング同期を実行します。

DatabaseRealtimeMigration

SourceDataSourceSettings

array<object>

任意

ソースデータソース設定のリスト。

array<object>

任意

単一のソースデータソース設定。

DataSourceName

string

任意

データソースの名前。

mysql_datasource_1

DataSourceProperties

object

任意

データソースのプロパティ。

Encoding

string

任意

データベースのエンコーディング。

UTF-8

Timezone

string

任意

タイムゾーン。

Asia/Shanghai

ConnectionProperties

string

任意

このパラメーターまたは DataSourceName のいずれかを指定します。このパラメーターは、インスタンス ID、アクセス ID、インスタンスリージョンを含むカスタムデータソース接続設定情報を指定します。

このパラメーターは、インスタンスパターン (ConnectionPropertiesMode) のデータソース接続設定のみをサポートします。データソースごとにプロパティの仕様が異なります。詳細については、「データソース接続情報 ConnectionProperties」を参照してください。

{ "instanceId": "rm-2ze09gn3x6xxx", "password": "xxxx", "database": "agent", "username": "zmtest" "regionId": "cn-beijing" }

DestinationDataSourceSettings

array<object>

任意

送信先データソース設定のリスト。

array<object>

任意

単一の送信先データソース設定。

DataSourceName

string

任意

データソースの名前。

holo_datasource_1

DataSourceProperties

object

任意

データソースのプロパティ。

ConnectionProperties

string

任意

このパラメーターまたは DataSourceName のいずれかを指定します。このパラメーターは、インスタンス ID、アクセス ID、インスタンスリージョンを含むカスタムデータソース接続設定情報を指定します。

このパラメーターは、インスタンスパターン (ConnectionPropertiesMode) のデータソース接続設定のみをサポートします。データソースごとにプロパティの仕様が異なります。詳細については、「データソース接続情報 ConnectionProperties」を参照してください。

{ "instanceId": "rm-2ze09gn3x6xxx", "password": "xxxx", "database": "agent", "username": "zmtest" "regionId": "cn-beijing" }

ResourceSettings

object

任意

リソース設定。

OfflineResourceSettings

object

任意

オフライン同期リソース設定。

RequestedCu

number

任意

オフライン同期に使用される Data Integration リソースグループのコンピュートユニット (CU) 数。

2

ResourceGroupIdentifier

string

任意

オフライン同期に使用される Data Integration リソースグループの名前。

S_res_group_111_222

RealtimeResourceSettings

object

任意

リアルタイム同期リソース設定。

RequestedCu

number

任意

リアルタイム同期に使用される Data Integration リソースグループの CU 数。

2

ResourceGroupIdentifier

string

任意

リアルタイム同期に使用される Data Integration リソースグループの名前。

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

任意

単一の同期オブジェクト変換ルールの定義。各要素は 1 つの変換ルールを表します。

RuleActionType

string

任意

操作タイプ。有効な値:

  • DefinePrimaryKey: プライマリキーを定義します。

  • Rename: オブジェクトの名前を変更します。

  • AddColumn: 列を追加します。

  • HandleDml: DML 操作を処理します。

  • DefineIncrementalCondition: 増分条件を定義します。

  • DefineCycleScheduleSettings: サイクルスケジューリング設定を定義します。

  • DefinePartitionKey: パーティションキーを定義します。

Rename

RuleExpression

string

任意

JSON 文字列フォーマットのルール式。

  1. 名前変更ルール (Rename)

  • 例: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }

  • expression: 名前変更変換ルール式。式では次の変数がサポートされています: ${srcDatasourceName} (ソースデータソース名)、${srcDatabaseName} (ソースデータベース名)、${srcTableName} (ソーステーブル名)。

  1. 列追加ルール (AddColumn)

  • 例: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}

  • 指定しない場合、デフォルトのルールは列の追加もレプリケーションも実行しません。

  • columnName: 追加列の名前。

  • columnValueType: 追加列の値のタイプ。有効な値: Constant、Variable。

  • columnValue: 追加列の値。columnValueType が Constant に設定されている場合、値は String 型のカスタム定数です。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 型)。

  1. 送信先テーブルのプライマリキー列の定義 (DefinePrimaryKey)

  • 例: {"columns":["ukcolumn1","ukcolumn2"]}

  • 指定しない場合、デフォルトでソースのプライマリキー列が使用されます。

  • 送信先テーブルが既に存在する場合: Data Integration システムは送信先テーブルスキーマを変更しません。指定されたプライマリキー列が送信先の列セットにない場合、ノードは起動時にエラーを報告します。

  • 送信先テーブルが自動作成を使用する場合: Data Integration システムは送信先テーブルスキーマを自動的に作成し、定義されたプライマリキー列を含めます。指定されたプライマリキー列が送信先の列セットにない場合、ノードは起動時にエラーを報告します。

  1. 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 に設定されている場合に使用します。

  1. 増分条件 (DefineIncrementalCondition)

  • 例: {"where":"id > 0"}

  • 増分フィルター条件を指定します。

  1. サイクルスケジューリングパラメーター (DefineCycleScheduleSettings)

  • 例: {"cronExpress":" * * * * * *", "cycleType":"1"}

  • サイクルノードスケジューリングパラメーターを指定します。

  1. パーティションキーの定義 (DefinePartitionKey)

  • 例: {"columns":["id"]}

  • パーティションキーを指定します。

{

RuleName

string

任意

ルール名。操作タイプとターゲットタイプが同じ場合、ルール名は一意である必要があります。名前の長さは 50 文字を超えることはできません。

rename_rule_1

RuleTargetType

string

任意

操作が適用されるターゲットタイプ。有効な値:

  • Table

  • Schema

  • Database

Table

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

TransformationRules

array<object>

任意

同期オブジェクトの変換ルール定義のリスト。各要素は 1 つの変換ルールを表します。

object

任意

ソースオブジェクトに適用される変換ルール。

RuleName

string

任意

ルール名。同じ操作タイプとターゲットタイプの組み合わせ内で、名前は一意である必要があります。名前の長さは 50 文字を超えることはできません。

rename_rule_1

RuleActionType

string

任意

操作タイプ。有効な値:

  • DefinePrimaryKey: プライマリキーを定義します。

  • Rename: オブジェクトの名前を変更します。

  • AddColumn: 列を追加します。

  • HandleDml: DML 操作を処理します。

  • DefineIncrementalCondition: 増分条件を定義します。

  • DefineCycleScheduleSettings: サイクルスケジューリング設定を定義します。

  • DefinePartitionKey: パーティションキーを定義します。

Rename

RuleTargetType

string

任意

操作が適用されるターゲットタイプ。有効な値:

  • Table

  • Schema

  • Database

Table

JobSettings

object

任意

タスクレベルの設定。DDL 処理ポリシー、ソースから送信先への列データの型マッピングポリシー、タスクランタイムパラメーターが含まれます。

ChannelSettings

string

任意

チャンネル関連のタスク設定。特定のチャンネルに対して特別な設定を行うことができます。現在サポートされているチャンネルには、Holo2Holo (Hologres から Hologres への同期) および Holo2Kafka (Hologres から Kafka への同期) が含まれます。

  1. Holo2Kafka

  • 例: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}

  • kafkaClientProperties: Kafka への書き込み時に使用される Kafka プロデューサーパラメーター。

  • keyColumns: 値が Kafka に書き込まれる列。

  • writeMode: Kafka 書き込みフォーマット。現在は json と canal をサポートしています。

  1. Holo2Holo

  • 例: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}

  • conflictMode: Hologres への書き込み時の競合処理ポリシー。有効な値: replace (上書き)、ignore。

  • writeMode: Hologres の書き込みモード。有効な値: replay、insert。

  • dynamicColumnAction: Hologres への書き込み時の動的カラム処理モード。有効な値: replay、insert、ignore。

{

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

任意

サイクルスケジューリング設定。

CycleMigrationType

string

任意

サイクルスケジューリングが必要な同期タイプ。有効な値:

  • Full: フル同期。

  • OfflineIncremental: オフライン増分同期。

Full

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: フェールオーバー失敗後の再起動試行回数。

runtime.offline.concurrent

Value

string

任意

設定値。

1

JobName deprecated

string

任意

[非推奨] 代わりに Name パラメーターを使用してください。

mysql_to_holo_sync_8772

Owner

string

任意

タスクのオーナー。

3726346

FileSpec

string

任意

スクリプトモードのコード内容。

{

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

Id

integer

Data Integration タスクの ID。

11792

RequestId

string

リクエスト ID。この ID を使用してログを検索し、問題のトラブルシューティングを行うことができます。

4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB

DIJobId deprecated

integer

[非推奨] 代わりに Id レスポンスパラメーターを使用してください。

11792

例

成功レスポンス

JSONJSON

{
  "Id": 11792,
  "RequestId": "4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB",
  "DIJobId": 11792
}

エラーコード

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

変更履歴

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