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

:GetDIJob

最終更新日:Mar 21, 2026

Data Integration で作成した新バージョンの同期タスクに関する情報を照会します。サポートされる同期タスクの種類には、MySQL データベース内の全データを Hologres へリアルタイム同期するものがあります。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DIJobId

integer

必須

同期タスクの ID です。

11588

WithDetails

boolean

任意

変換ルール (TransformationRules)、テーブルマッピング (TableMappings)、ジョブ設定 (JobSettings) を含む詳細な構成情報を返すかどうかを指定します。有効な値:true、false。デフォルト値:true。

true

レスポンスフィールド

フィールド

説明

object

応答結果です。

Data

object

同期タスクの情報です。

ProjectId

integer

ワークスペース ID です。

22

DIJobId

integer

同期タスクの ID です。

11588

JobName

string

同期タスクの名前です。

mysql_to_holo_sync_445

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

送信先のプロパティです。DataWorks では 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

ソースから選択された同期対象オブジェクトに適用される変換ルールです。

RuleActionType

string

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

  • DefinePrimaryKey

  • Rename

  • AddColumn

  • HandleDml

  • DefineIncrementalCondition

  • DefineCycleScheduleSettings

  • DefineRuntimeSettings

  • DefinePartitionKey

Rename

RuleExpression

string

ルールの式です。式は JSON 文字列です。

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

    • expression:名前の変更ルールの式です。式には以下の変数を含めることができます。

      • ${srcDatasourceName}

      • ${srcDatabaseName}

      • ${srcTableName}

    • variables:名前の変更ルールの式で使用される変数の生成ルールです。指定された変数のデフォルト値は、変数が示すオブジェクトの元の値です。元の値を変更するための文字列置き換えルールのグループが返される場合があります。

      • variableName:変数の名前です。変数名は ${} で囲まれません。

      • variableRules:変数の文字列置き換えルールです。システムは文字列置き換えルールを順次実行します。from は元の文字列、to は新しい文字列です。

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

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

    • columnName:追加するフィールドの名前です。

    • columnValueType:フィールドの値の型です。有効な値:Constant、Variable。

    • columnValue:フィールドの値です。

      • columnValueType パラメーターの値が Constant の場合、columnValue パラメーターの値は STRING 型の定数です。

      • columnValueType パラメーターの値が 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}"}

RuleName

string

ルールの名前です。複数の変換ルールで RuleActionType パラメーターと RuleTargetType パラメーターの値が同じである場合、変換ルールの名前は一意である必要があります。

rename_rule_1

RuleTargetType

string

操作対象のオブジェクトのタイプです。有効な値:

  • Table

  • Schema

Table

TableMappings

array<object>

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

array<object>

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

SourceObjectSelectionRules

array<object>

ソースから同期対象オブジェクトを選択するためのルールの一覧です。

object

ソースから同期対象オブジェクト(データベースまたはテーブル)を選択するためのルールです。

Expression

string

式です。

mysql_table_1

ObjectType

string

オブジェクトタイプです。有効な値:

  • Table

  • Database

Table

TransformationRules

array<object>

ソースから選択された同期対象オブジェクトに適用される変換ルールの一覧です。

object

ソースから選択された同期対象オブジェクトに適用される変換ルールです。

RuleActionType

string

操作タイプです。有効な値:

  • DefinePrimaryKey

  • Rename

  • AddColumn

  • HandleDml

  • DefineIncrementalCondition

  • DefineCycleScheduleSettings

  • DefineRuntimeSettings

  • DefinePartitionKey

Rename

RuleName

string

ルールの名前です。複数の変換ルールで RuleActionType パラメーターと RuleTargetType パラメーターの値が同じである場合、変換ルールの名前は一意である必要があります。

rename_rule_1

RuleTargetType

string

操作対象のオブジェクトのタイプです。有効な値:

  • Table

  • Schema

Table

JobSettings

object

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

ColumnDataTypeSettings

array<object>

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

object

SourceDataType

string

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

bigint

DestinationDataType

string

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

text

DdlHandlingSettings

array<object>

DDL メッセージの処理設定です。このパラメーターの値は配列です。

object

特定のタイプの DDL メッセージに対する処理設定です。

Action

string

処理ポリシーです。有効な値:

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

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

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

Critical

Type

string

DDL 操作のタイプです。有効な値:

  • RenameColumn

  • ModifyColumn

  • CreateTable

  • TruncateTable

  • DropTable

  • DropColumn

  • AddColumn

AddColumn

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":""}

CreatedTime

integer

同期タスクが作成されたタイムスタンプです。秒単位の精度です。

1671516776

CreatedUid

string

同期タスクを作成したユーザーの ID です。

100000001

UpdatedTime

integer

同期タスクが最後に変更されたタイムスタンプです。秒単位の精度です。

1673859985

UpdatedUid

string

同期タスクを最後に変更したユーザーの ID です。

100000001

StartedTime

integer

同期タスクが最後に開始されたタイムスタンプです。秒単位の精度です。

1673859999

StartedUid

string

同期タスクを最後に開始したユーザーの ID です。

100000001

JobStatus

string

同期タスクのステータスです。有効な値:

  • Finished

  • Initialized

  • Stopped

  • Failed

  • Running

  • Stopping

Finished

ErrorMessage

string

JobStatus パラメーターの値が Failed の場合に返されるエラーメッセージです。

error details xxx

RunStats

object

同期タスクの実行に関する情報です。

string

同期タスクの実行に関する詳細な統計情報です。

  • StructureMigrationTotalTables:スキーマ移行が必要なテーブルの合計数

  • StructureMigrationSuccessTables:スキーマ移行が正常に完了したテーブルの数

  • StructureMigrationFailedTables:スキーマ移行に失敗したテーブルの数

  • StructureMigrationStatus:スキーマ移行のステータス。有効な値:Waiting、Running、Finished、Failed、Stopped

  • StructureMigrationErrorMessage:スキーマ移行に関するエラーメッセージ

  • FullMigrationTotalTables:完全データの同期が必要なテーブルの合計数

  • FullMigrationSuccessTables:完全データの同期が正常に完了したテーブルの数

  • FullMigrationFailedTables:完全データの同期に失敗したテーブルの数

  • FullMigrationStatus:完全同期のステータス

  • FullMigrationErrorMessage:完全同期に関するエラーメッセージ

  • RealtimeMigrationMaxDelay:リアルタイム同期の遅延。単位:ミリ秒

  • RealtimeMigrationStatus:リアルタイム同期のステータス

  • RealtimeMigrationErrorMessage:リアルタイム同期に関するエラーメッセージ

StructureMigrationTotalTables

RequestId

string

リクエスト ID です。

0000-ABCD-EFG****

成功レスポンス

JSONJSON

{
  "Data": {
    "ProjectId": 22,
    "DIJobId": 11588,
    "JobName": "mysql_to_holo_sync_445",
    "Description": "Synchronize mysql to hologres\n",
    "MigrationType": "FullAndRealtimeIncremental",
    "SourceDataSourceType": "MySQL",
    "DestinationDataSourceType": "Hologres",
    "SourceDataSourceSettings": [
      {
        "DataSourceName": "mysql_datasource_1",
        "DataSourceProperties": {
          "key": "TimeZone"
        }
      }
    ],
    "DestinationDataSourceSettings": [
      {
        "DataSourceName": "holo_datasource_1",
        "DataSourceProperties": {
          "key": "TimeZone"
        }
      }
    ],
    "ResourceSettings": {
      "OfflineResourceSettings": {
        "ResourceGroupIdentifier": "S_res_group_111_222"
      },
      "RealtimeResourceSettings": {
        "ResourceGroupIdentifier": "S_res_group_111_222"
      },
      "RequestedCu": 2
    },
    "TransformationRules": [
      {
        "RuleActionType": "Rename",
        "RuleExpression": "{\"expression\":\"${srcDatasoureName}_${srcDatabaseName}\"}",
        "RuleName": "rename_rule_1",
        "RuleTargetType": "Table"
      }
    ],
    "TableMappings": [
      {
        "SourceObjectSelectionRules": [
          {
            "Expression": "mysql_table_1",
            "ObjectType": "Table"
          }
        ],
        "TransformationRules": [
          {
            "RuleActionType": "Rename",
            "RuleName": "rename_rule_1",
            "RuleTargetType": "Table"
          }
        ]
      }
    ],
    "JobSettings": {
      "ColumnDataTypeSettings": [
        {
          "SourceDataType": "bigint",
          "DestinationDataType": "text"
        }
      ],
      "DdlHandlingSettings": [
        {
          "Action": "Critical",
          "Type": "AddColumn"
        }
      ],
      "RuntimeSettings": [
        {
          "Name": "runtime.offline.concurrent",
          "Value": "1"
        }
      ],
      "CycleScheduleSettings": {
        "CycleMigrationType": "Full",
        "ScheduleParameters": "bizdate=$bizdate"
      },
      "ChannelSettings": "{\"structInfo\":\"MANAGED\",\"storageType\":\"TEXTFILE\",\"writeMode\":\"APPEND\",\"partitionColumns\":[{\"columnName\":\"pt\",\"columnType\":\"STRING\",\"comment\":\"\"}],\"fieldDelimiter\":\"\"}\n"
    },
    "CreatedTime": 1671516776,
    "CreatedUid": "100000001",
    "UpdatedTime": 1673859985,
    "UpdatedUid": "100000001",
    "StartedTime": 1673859999,
    "StartedUid": "100000001",
    "JobStatus": "Finished",
    "ErrorMessage": "error details xxx",
    "RunStats": {
      "key": "StructureMigrationTotalTables"
    }
  },
  "RequestId": "0000-ABCD-EFG****"
}

エラーコード

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.

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

変更履歴

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