すべてのプロダクト
Search

このプロダクト

    DataWorks:GetDIJob

    ドキュメントセンター

    DataWorks:GetDIJob

    最終更新日:Mar 26, 2026

    データ統合タスクを表示します。

    操作説明

    この操作には、DataWorks Basic Edition 以降が必要です。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    integer

    任意

    DI ジョブの ID。

    11588
    WithDetails

    boolean

    任意

    TransformationRules、TableMappings、JobSettings などの詳細な構成を返すかどうかを指定します。この構成はデフォルトで返されます。

    true
    ProjectId

    integer

    任意

    DataWorks ワークスペースの ID。ListProjects 操作を呼び出してワークスペース ID を取得できます。

    10000
    DIJobId deprecated

    integer

    任意

    このフィールドは非推奨です。代わりに Id フィールドを使用してください。

    11588

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    RequestId

    string

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

    C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490
    PagingInfo

    object

    データ統合ジョブの詳細。

    Id

    integer

    ジョブ ID。

    32601
    Description

    string

    ジョブの説明。

    description
    DestinationDataSourceSettings

    array<object>

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

    object

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

    DataSourceName

    string

    送信先データソースの名前。

    dw_mysql
    DestinationDataSourceType

    string

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

    Hologres
    JobName

    string

    ジョブの名前。

    imp_ods_dms_det_dealer_info_df
    JobSettings

    object

    ジョブの設定。

    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。

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

    array<object>

    列データ型マッピング。

    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 メッセージを処理するための設定の配列。各要素は DDL メッセージタイプと対応する処理ルールを指定します。

    object

    DDL メッセージタイプを処理するためのルール。

    Action

    string

    処理アクション。有効な値：

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

    • Critical：エラーを報告します。

    • Normal：DDL メッセージを処理します。

    Ignore
    Type

    string

    DDL メッセージタイプ。有効な値：

    • RenameColumn

    • ModifyColumn

    • CreateTable

    • TruncateTable

    • DropTable

    CreateTable
    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
    MigrationType

    string

    同期タイプ。有効な値：

    • FullAndRealtimeIncremental：1 回限りの完全同期とリアルタイム増分同期 (データベース全体)。

    • RealtimeIncremental：リアルタイム増分同期 (単一テーブル)。

    • Full：1 回限りの完全同期 (データベース全体)。

    • OfflineIncremental：オフライン増分同期 (データベース全体)。

    • FullAndOfflineIncremental：1 回限りの完全同期とオフライン増分同期 (データベース全体)。

    FullAndRealtimeIncremental
    JobType

    string

    ジョブタイプ。

    • DatabaseRealtimeMigration：複数のソースデータベースからの複数テーブルのリアルタイム同期。このタイプは、完全同期、増分同期、またはその両方をサポートします。

    • DatabaseOfflineMigration：複数のソースデータベースからの複数テーブルのバッチ同期。このタイプは、完全同期、増分同期、またはその両方をサポートします。

    • SingleTableRealtimeMigration：単一のソーステーブルのリアルタイム同期。

    DatabaseRealtimeMigration
    ProjectId

    integer

    API 呼び出しのための DataWorks ワークスペースの ID。DataWorks コンソールの [ワークスペース設定] ページからワークスペース ID を取得できます。

    98330
    ResourceSettings

    object

    リソース設定。

    OfflineResourceSettings

    object

    オフライン同期ジョブのリソース設定。

    RequestedCu

    number

    オフライン同期ジョブのためのデータ統合リソースグループからの CU 数。

    2.0
    ResourceGroupIdentifier

    string

    オフライン同期ジョブで使用されるデータ統合リソースグループの名前。

    di_resourcegroup_v1
    RealtimeResourceSettings

    object

    リアルタイム同期ジョブのリソース設定。

    RequestedCu

    number

    リアルタイム同期ジョブのためのデータ統合リソースグループからの CU 数。

    2.0
    ResourceGroupIdentifier

    string

    リアルタイムジョブで使用されるデータ統合リソースグループの名前。

    di_resourcegroup_v1
    ScheduleResourceSettings

    object

    スケジューリングリソース設定。

    RequestedCu

    number

    オフラインスケジューリングジョブのためのスケジューリングリソースグループからの CU 数。

    2.0
    ResourceGroupIdentifier

    string

    オフラインスケジューリングジョブで使用されるスケジューリングリソースグループの名前。

    schedual_resourcegroup_v1
    SourceDataSourceSettings

    array<object>

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

    array<object>

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

    DataSourceName

    string

    データソースの名前。

    dw_mysql
    DataSourceProperties

    object

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

    Encoding

    string

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

    UTF-8

    Timezone

    string

    タイムゾーン。

    GMT+8

    SourceDataSourceType

    string

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

    Mysql
    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>

    各ルールは、同期するソースオブジェクトのセットを選択します。複数のルールの組み合わせで 1 つのテーブルが選択されます。

    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) に対して一意である必要があります。

    rename_rule_1
    RuleActionType

    string

    アクションタイプ。有効な値：

    • DefinePrimaryKey

    • Rename

    • AddColumn

    • HandleDml

    AddColumn
    RuleTargetType

    string

    アクションのターゲットオブジェクトタイプ。有効な値：

    • Table

    • Schema

    • Database

    Table
    TransformationRules

    array<object>

    オブジェクト変換ルールの定義のリスト。

    説明

    [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{\"expression\":\"${srcDatasoureName}_${srcDatabaseName}\"}" } ]

    object

    オブジェクト変換ルールの定義。

    RuleActionType

    string

    アクションタイプ。有効な値：

    • DefinePrimaryKey

    • Rename

    • AddColumn

    • HandleDml

    • 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 の場合、値はカスタム文字列定数です。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"]}

    • デフォルトでは、ソーステーブルのプライマリキー列が使用されます。

    • 送信先テーブルが既に存在する場合、データ統合システムはテーブルスキーマを変更しません。指定されたプライマリキー列が送信先テーブルにない場合、ジョブの開始に失敗します。

    • 送信先テーブルが自動的に作成される場合、データ統合システムは定義されたプライマリキー列を含むテーブルスキーマを自動的に作成します。指定されたプライマリキー列が送信先テーブルにない場合、ジョブの開始に失敗します。

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

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

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

    string

    ルールの名前。ルール名は、特定のアクションタイプ (RuleActionType) とターゲットタイプ (RuleTargetType) に対して一意である必要があります。

    rename_rule_1
    RuleTargetType

    string

    アクションのターゲットオブジェクトタイプ。有効な値：

    • Table

    • Schema

    • Database

    Table
    JobStatus

    string

    ジョブのステータス。有効な値：

    • Finished：ジョブは完了しました。

    • Failed：ジョブは失敗しました。

    • Running：ジョブは実行中です。

    • Initialized：ジョブは初期化されましたが、開始されていません。

    • Stopping：ジョブは停止中です。

    • Stop：ジョブは停止しました。

    Running
    DIJobId deprecated

    string

    このフィールドは非推奨です。代わりに Id フィールドを使用してください。

    32601
    Owner

    string

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
  "PagingInfo": {
    "Id": 32601,
    "Description": "description",
    "DestinationDataSourceSettings": [
      {
        "DataSourceName": "dw_mysql"
      }
    ],
    "DestinationDataSourceType": "Hologres",
    "JobName": "imp_ods_dms_det_dealer_info_df",
    "JobSettings": {
      "ChannelSettings": "{\"structInfo\":\"MANAGED\",\"storageType\":\"TEXTFILE\",\"writeMode\":\"APPEND\",\"partitionColumns\":[{\"columnName\":\"pt\",\"columnType\":\"STRING\",\"comment\":\"\"}],\"fieldDelimiter\":\"\"}",
      "ColumnDataTypeSettings": [
        {
          "DestinationDataType": "text",
          "SourceDataType": "bigint"
        }
      ],
      "CycleScheduleSettings": {
        "CycleMigrationType": "Full",
        "ScheduleParameters": "bizdate=$bizdate\n"
      },
      "DdlHandlingSettings": [
        {
          "Action": "Ignore",
          "Type": "CreateTable"
        }
      ],
      "RuntimeSettings": [
        {
          "Name": "runtime.offline.concurrent\n",
          "Value": "1"
        }
      ]
    },
    "MigrationType": "FullAndRealtimeIncremental",
    "JobType": "DatabaseRealtimeMigration",
    "ProjectId": 98330,
    "ResourceSettings": {
      "OfflineResourceSettings": {
        "RequestedCu": 2,
        "ResourceGroupIdentifier": "di_resourcegroup_v1"
      },
      "RealtimeResourceSettings": {
        "RequestedCu": 2,
        "ResourceGroupIdentifier": "di_resourcegroup_v1"
      },
      "ScheduleResourceSettings": {
        "RequestedCu": 2,
        "ResourceGroupIdentifier": "schedual_resourcegroup_v1"
      }
    },
    "SourceDataSourceSettings": [
      {
        "DataSourceName": "dw_mysql",
        "DataSourceProperties": {
          "Encoding": "UTF-8\n",
          "Timezone": "GMT+8\n"
        }
      }
    ],
    "SourceDataSourceType": "Mysql",
    "TableMappings": [
      {
        "SourceObjectSelectionRules": [
          {
            "Action": "Include",
            "Expression": "mysql_table_1",
            "ExpressionType": "Exact",
            "ObjectType": "Table"
          }
        ],
        "TransformationRules": [
          {
            "RuleName": "rename_rule_1",
            "RuleActionType": "AddColumn",
            "RuleTargetType": "Table"
          }
        ]
      }
    ],
    "TransformationRules": [
      {
        "RuleActionType": "Rename",
        "RuleExpression": "{\"expression\":\"${srcDatasoureName}_${srcDatabaseName}\"}",
        "RuleName": "rename_rule_1",
        "RuleTargetType": "Table"
      }
    ],
    "JobStatus": "Running",
    "DIJobId": "32601",
    "Owner": ""
  }
}

    エラーコード

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

    変更履歴

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