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

:CreateDIJob

最終更新日:Mar 21, 2026

新バージョンの同期タスクを作成します。サポートされる同期タスクの種類は、MySQL データベース内の全データを Hologres にリアルタイム同期するものと、MySQL データベース内の全データを Hive にバッチ同期するものです。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectId

integer

任意

DataWorks ワークスペース ID。この ID は、ListProjects API を呼び出すことで取得できます。

10000

JobName

string

任意

同期タスクの名前。

mysql_to_holo_sync_8772

Description

string

任意

同期タスクの説明。

Synchronize mysql to hologres

MigrationType

string

任意

同期タイプ。有効な値は以下のとおりです。

  • FullAndRealtimeIncremental(一度限りの完全同期およびリアルタイム増分同期)

  • RealtimeIncremental(リアルタイム増分同期)

  • Full(完全同期)

  • OfflineIncremental(バッチ増分同期)

  • FullAndOfflineIncremental(一度限りの完全同期およびバッチ増分同期)

FullAndRealtimeIncremental

SourceDataSourceType

string

任意

ソースタイプ。このパラメーターは MySQL に設定してください。

MySQL

DestinationDataSourceType

string

任意

送信先タイプ。有効な値は Hologres および Hive です。

Hologres

SourceDataSourceSettings

array<object>

任意

ソースの設定。単一のソースのみがサポートされます。

array<object>

任意

DataSourceName

string

任意

データソースの名前。

mysql_datasource_1

DataSourceProperties

object

任意

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

string

任意

ソースのプロパティ。MySQL データソースのプロパティには、TimeZone および Encoding が含まれます。

TimeZone

DestinationDataSourceSettings

array<object>

任意

送信先の設定。単一の送信先のみがサポートされます。

array<object>

任意

DataSourceName

string

任意

データソースの名前。

holo_datasource_1

DataSourceProperties

object

任意

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

string

任意

送信先のプロパティ。Hologres データソースでは、プロパティの設定はできません。

TimeZone

ResourceSettings

object

任意

リソース設定。

OfflineResourceSettings

object

任意

バッチ同期に使用されるリソース。

ResourceGroupIdentifier

string

任意

バッチ同期に使用される Data Integration のリソースグループ識別子。

S_res_group_111_222

RealtimeResourceSettings

object

任意

リアルタイム同期に使用されるリソース。

ResourceGroupIdentifier

string

任意

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

S_res_group_111_222

RequestedCu

number

任意

増分同期および完全同期に使用されるリソースグループ内の計算ユニット (CU) 数。

2.0

TransformationRules

array<object>

任意

ソースから選択した同期対象に適用する変換ルールのリスト。リスト内の各エントリは、1 つの変換ルールを定義します。

object

任意

ソースから選択した同期対象に適用する変換ルール。

RuleName

string

任意

ルールの名前。複数の変換ルールで RuleActionType パラメーターおよび RuleTargetType パラメーターの値が同一の場合、変換ルール名が一意であることを確認してください。

rename_rule_1

RuleActionType

string

任意

操作タイプ。有効な値は以下のとおりです。

  • DefinePrimaryKey

  • Rename

  • AddColumn

  • HandleDml

  • DefineIncrementalCondition

  • DefineCycleScheduleSettings

  • DefineRuntimeSettings

  • DefinePartitionKey

Rename

RuleTargetType

string

任意

操作を実行するオブジェクトのタイプ。有効な値は以下のとおりです。

  • Table

  • Schema

Table

RuleExpression

string

任意

ルールの式。式は JSON 文字列である必要があります。

名前の変更ルールの例:{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":[{"variableName":"srcDatabaseName","variableRules":[{"from":"fromdb","to":"todb"}]}]}

  • expression:名前の変更ルールの式。式内で使用できる変数は、${srcDatasourceName}、${srcDatabaseName}、および ${srcTableName} です。${srcDatasourceName} はソースの名前を示し、${srcDatabaseName} はソースデータベースの名前を示し、${srcTableName} はソーステーブルの名前を示します。

  • variables:式内で使用される変数の生成ルール。指定された変数のデフォルト値は、変数が示すオブジェクトの元の値です。ビジネス要件に応じて、文字列置き換えルールのグループを定義して、元の値を変更できます。variableName:変数の名前。変数名は ${} で囲まないでください。variableRules:変数の文字列置き換えルール。システムは、文字列置き換えルールを順次実行します。from は元の文字列を指定し、to は新しい文字列を指定します。

送信先に特定のフィールドを追加して値を割り当てるルールの例:{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}

  • このようなルールを設定しない場合、デフォルトで送信先にフィールドは追加されず、値も割り当てられません。

  • columnName:追加されるフィールドの名前。

  • columnValueType:フィールドの値のタイプ。有効な値は Constant および Variable です。

  • columnValue:追加するフィールドの値。valueType パラメーターを Constant に設定した場合は、columnValue パラメーターを STRING 型のカスタム定数に設定します。valueType パラメーターを Variable に設定した場合は、columnValue を組み込み変数に設定します。サポートされる組み込み変数は、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 型)です。EXECUTE_TIME は実行時刻を指定します。DB_NAME_SRC はソースデータベースの名前を指定します。DATASOURCE_NAME_SRC はソースの名前を指定します。TABLE_NAME_SRC はソーステーブルの名前を指定します。DB_NAME_DEST は送信先データベースの名前を指定します。DATASOURCE_NAME_DEST は送信先の名前を指定します。TABLE_NAME_DEST は送信先テーブルの名前を指定します。DB_NAME_SRC_TRANSED は変換後のデータベース名を指定します。

送信先テーブルのプライマリキーを指定するルールの例:{"columns":["ukcolumn1","ukcolumn2"]}

  • このようなルールを設定しない場合、マッピングされたソーステーブルのプライマリキーが、デフォルトで送信先テーブルに使用されます。

  • 送信先テーブルが既存のテーブルである場合、Data Integration は送信先テーブルのスキーマを変更しません。指定されたプライマリキーが送信先テーブルに存在しない場合、同期タスクの実行開始時にエラーが報告されます。

  • 送信先テーブルがシステムによって自動的に作成される場合、Data Integration は送信先テーブルのスキーマを自動的に作成します。このスキーマには、指定されたプライマリキーが含まれます。指定されたプライマリキーが送信先テーブルに存在しない場合、同期タスクの実行開始時にエラーが報告されます。

DML メッセージを処理するルールの例:{"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}

  • このようなルールを設定しない場合、挿入、更新、削除操作に対して生成されるメッセージのデフォルト処理ポリシーは Normal です。

  • dmlType:DML 操作。有効な値は Insert、Update、および Delete です。

  • dmlAction:DML メッセージの処理ポリシー。有効な値は Normal、Ignore、Filter、および LogicalDelete です。Filter は条件付き処理を意味します。dmlAction パラメーターを Filter に設定できるのは、dmlType パラメーターが Update または Delete に設定されている場合のみです。

  • filterCondition:DML メッセージをフィルター処理するための条件。dmlAction パラメーターが Filter に設定されている場合にのみ、このパラメーターが必要です。

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

TableMappings

array<object>

任意

ソースから同期対象を選択するルールと、選択された同期対象に適用される変換ルールとの間のマッピングのリスト。リスト内の各エントリは、同期対象を選択するルールと、選択された同期対象に適用される変換ルールとのマッピングを表示します。

array<object>

任意

ソースから同期対象を選択するルールと、選択された同期対象に適用される変換ルールとのマッピング。

SourceObjectSelectionRules

array<object>

任意

ソースから同期対象を選択するルール。

object

任意

ソースから同期対象を選択するルール。対象はデータベースまたはテーブルになります。

ObjectType

string

任意

オブジェクトタイプ。有効な値は以下のとおりです。

  • Table

  • Database

Table

Expression

string

任意

式。

mysql_table_1

TransformationRules

array<object>

任意

ソースから選択した同期対象に適用する変換ルールのリスト。

object

任意

ソースから選択した同期対象に適用する変換ルール。

RuleName

string

任意

ルールの名前。複数の変換ルールで RuleActionType パラメーターおよび RuleTargetType パラメーターの値が同一の場合、変換ルール名が一意であることを確認してください。

rename_rule_1

RuleActionType

string

任意

操作タイプ。有効な値は以下のとおりです。

  • DefinePrimaryKey

  • Rename

  • AddColumn

  • HandleDml

  • DefineIncrementalCondition

  • DefineCycleScheduleSettings

  • DefineRuntimeSettings

  • DefinePartitionKey

Rename

RuleTargetType

string

任意

操作を実行するオブジェクトのタイプ。有効な値は以下のとおりです。

  • Table

  • Schema

Table

JobSettings

object

任意

同期タスクのディメンションに関する設定。設定には、DDL メッセージの処理ポリシー、ソースフィールドと送信先フィールド間のデータ型マッピングのポリシー、および同期タスクの実行時パラメーターが含まれます。

DdlHandlingSettings

array<object>

任意

DDL メッセージの処理設定。

object

任意

特定の DDL メッセージの処理設定。

Type

string

任意

DDL 操作のタイプ。有効な値は以下のとおりです。

  • RenameColumn

  • ModifyColumn

  • CreateTable

  • TruncateTable

  • DropTable

  • DropColumn

  • AddColumn

AddColumn

Action

string

任意

処理ポリシー。有効な値は以下のとおりです。

  • Ignore:DDL メッセージを無視します。

  • Critical:DDL メッセージに対してエラーを報告します。

  • Normal:DDL メッセージを通常通り処理します。

Critical

ColumnDataTypeSettings

array<object>

任意

ソースフィールドと送信先フィールド間のデータ型マッピングの設定。このパラメーターの値は配列である必要があります。

object

任意

ソースフィールドと送信先フィールド間のデータ型マッピング。

SourceDataType

string

任意

ソースフィールドのデータ型。

bigint

DestinationDataType

string

任意

送信先フィールドのデータ型。

text

RuntimeSettings

array<object>

任意

実行時設定。このパラメーターの値は配列である必要があります。

object

任意

実行時設定。

Name

string

任意

設定項目の名前。有効な値は以下のとおりです。

  • runtime.offline.speed.limit.mb:バッチ同期タスクで許可される最大転送レートを指定します。この設定項目は、runtime.offline.speed.limit.enable が true に設定されている場合にのみ有効です。

  • runtime.offline.speed.limit.enable:バッチ同期タスクでの速度制限の有効化を指定します。

  • dst.offline.connection.max:バッチ同期タスクの送信先へのデータ書き込みに許可される最大接続数を指定します。

  • runtime.offline.concurrent:バッチ同期タスクで許可される最大並列スレッド数を指定します。

  • dst.realtime.connection.max:リアルタイム同期タスクの送信先へのデータ書き込みに許可される最大接続数を指定します。

  • runtime.enable.auto.create.schema:同期タスクの送信先でスキーマを自動作成するかどうかを指定します。

  • src.offline.datasource.max.connection:バッチ同期タスクのソースからのデータ読み取りに許可される最大接続数を指定します。

  • runtime.realtime.concurrent:リアルタイム同期タスクで許可される最大並列スレッド数を指定します。

runtime.offline.concurrent

Value

string

任意

設定項目の値。

1

CycleScheduleSettings

object

任意

定期スケジューリングの設定。

CycleMigrationType

string

任意

定期スケジューリングを必要とする同期タイプ。有効な値は以下のとおりです。

  • Full:完全同期

  • OfflineIncremental:バッチ増分同期

Full

ScheduleParameters

string

任意

スケジューリングパラメーター。

bizdate=$bizdate

ChannelSettings

string

任意

同期タスクのチャネル制御設定。このパラメーターの値は JSON 文字列である必要があります。

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

ImportRuleSettings

object

任意

同期タスクのインポート設定。

Source

string

任意

タスクのインポート元。値は DataStudio に設定します。これは DataStudio で作成された同期タスクを意味します。

Datastudio

FileId

string

任意

インポート対象のタスク ID。

10000

SystemDebug

string

任意

システムデバッグを実行するかどうかを指定します。有効な値は true および false です。デフォルト値は false です。

false

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエスト ID。この ID を使用してログを照会したり、問題のトラブルシューティングを行ったりできます。

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

DIJobId

integer

同期タスク ID。

11792

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

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

変更履歴

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