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

:UpdateDIJob

最終更新日:Mar 21, 2026

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

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

DIJobId

integer

任意

同期タスクの ID。

11588

Description

string

任意

同期タスクの説明。

mysql同步到hologres

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

任意

DDL メッセージの処理ポリシー。有効な値:

  • 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

任意

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

ScheduleParameters

string

任意

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

bizdate=$bizdate

ChannelSettings

string

任意

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

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

レスポンスフィールド

フィールド

説明

object

返却結果。

RequestId

string

リクエスト ID。

AAC30B35-820D-5F3E-A42C-E96BB6379325

成功レスポンス

JSONJSON

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

エラーコード

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.

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

変更履歴

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