データベース取り込みおよびレプリケーションREST APIとアプリケーション取り込みおよびレプリケーションREST API このセクションのREST APIリソースは、データ取り込みおよびレプリケーション サービスのデータベース取り込みとレプリケーション タスクとアプリケーション取り込みとレプリケーション タスクの両方に適用されます。
両方のタスクタイプは同じベースURL、URI、要求構造、ヘッダーを使用します。具体的なタスクタイプは、taskType フィールド値によって決まります。この値は、タスクを作成する際に要求ペイロードで指定する必要があります。
ベースURLとURI ログイン応答から、次のURIのベースURLとしてserverUrl値を使用します。例:
https://na4-ing.dm-us.informaticacloud.com
すべてのAPI呼び出しで次のURIを使用します。
/dbmi/public/api/v2/<API name>
要求ヘッダー すべての要求には次のヘッダー形式を含める必要があります。
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version>
API呼び出しの例 serverUrlがhttps://na4.dm-us.informaticacloud.com/saasで、URIが/dbmi/public/api/v2/task/createの場合、タスクを作成するためのAPI呼び出しは、次のような構造のPOST要求になります。
<METHOD> https://na4-ing.dm-us.informaticacloud.com/dbmi/public/api/v2/task/create HTTP/1.1 Content-Type: application/json
データベース取り込みおよびレプリケーションタスクとアプリケーション取り込みおよびレプリケーションタスクの作成 タスクリソースを使用して、指定したプロジェクトやフォルダにデータベース取り込みとレプリケーション タスクまたはアプリケーション取り込みとレプリケーション タスクを作成します。
POST要求 次のPOST要求を使用してタスクを作成します。
/dbmi/public/api/v2/task/create
作成するタスクのタイプを指定するために、要求ペイロードにtaskType フィールドを含める必要があります。
• アプリケーション取り込みとレプリケーション タスクの場合は"appmi"• データベース取り込みとレプリケーション タスクの場合は"dbmi"taskType フィールドの値を省略すると、デフォルトの"dbmi"になります。
指定したタスクタイプに関連するソース接続およびターゲット接続と、タスクプロパティのみを含めます。タスクタイプでサポートされているソースとターゲットの詳細については、『アプリケーション取り込みおよびレプリケーション』および『データベース取り込みおよびレプリケーション』のドキュメントを参照してください。
要求ペイロードの例 アプリケーション取り込みとレプリケーション タスクの場合、taskType フィールドを使用した要求ペイロードは次のようになります。
{
データベース取り込みとレプリケーション タスクの場合、taskType フィールドを使用した要求ペイロードは次のようになります。
{
次の表に、要求の基本属性を示します。
フィールド
タイプ
説明
taskType
文字列
作成する取り込みおよびレプリケーションタスクのタイプ。
次のオプションがあります。
- appmi 。アプリケーション取り込みとレプリケーション タスクを作成する。- dbmi 。データベース取り込みとレプリケーション タスクを作成する。デフォルトはdbmiです。
名前
文字列
タスクの名前。
説明
文字列
タスクのオプションの説明。
location
文字列
タスク定義を含むプロジェクトまたはプロジェクトフォルダ。
runtimeEnvironment
文字列
タスクを実行するランタイム環境。
タイプ
文字列
タスクで実行するロード操作のタイプ。
次のオプションがあります。
- initial 。ある時点で読み取られたソースデータをターゲットにロードします。データがロードされると、取り込みおよびレプリケーションジョブは終了します。- cdc 。データの変更を継続的に、または取り込みおよびレプリケーションジョブが停止または終了するまでロードします。取り込みおよびレプリケーションジョブは、最後に実行されてから、または特定の開始点から発生した変更をロードします。- combined 。ターゲットへのポイントインタイムデータの初期ロードを実行してから、同じソースオブジェクトに対して継続的に行われた増分データ変更のレプリケートに自動的に切り替わります。
次の表に、要求内のソース接続とタスクの属性を示します。
フィールド
タイプ
説明
connection
文字列
ソースシステムの接続の名前。
schema
文字列
ソーステーブルを含むソーススキーマ。
このオプションは、MongoDB以外のすべてのデータベース取り込みとレプリケーション ソースに適用されます。
salesforceAPI
文字列
アプリケーション取り込みとレプリケーション タスクのSalesforceソースの場合、ソースデータの取得に使用するSalesforce APIのタイプ。次のオプションがあります。
- Standard (REST) API 。Base64データ型のソースフィールドをレプリケートします。- Bulk API 2.0 。Base64データ型のソースフィールドのレプリケーションを除外します。デフォルトは［Bulk API 2.0］です。
database
文字列
データベース取り込みとレプリケーション タスクのMongoDBソースの場合、ソースデータを含むコレクションを保存するMongoDBデータベース。
journalName
文字列
データベース取り込みとレプリケーション タスクのDb2 for i増分ロードの場合、ソーステーブルの変更を記録するジャーナルの名前。
replicationSlotName
文字列
PostgreSQLソースの場合、PostgreSQLレプリケーションスロットの一意の名前。
replicationPlugin
文字列
データベース取り込みとレプリケーション タスクのPostgreSQLソースの場合、レプリケーションプラグイン。次のオプションがあります。
publication
文字列
データベース取り込みとレプリケーション タスクのPostgreSQLソースの場合、pgoutputプラグインで使用されるパブリケーションの名前。このパラメータは、replicationPlugin値としてpgoutputを指定した場合にのみ使用します。
selectionRules
リスト
ソースオブジェクトまたはソーステーブルのサブセットを選択するためのオプションのルール。
デフォルトは「include all *」です。このルールはタスクのソーススキーマのすべてのテーブルを選択します。
タスクで処理するテーブルを絞り込むには、追加の含めるルール、除外ルール、または両方のタイプのルールを定義できます。
例:
selectionRules: - include: TABLE_1 - exclude: TABLE_2
restartPointForIncrementalLoad
文字列
アプリケーション取り込みとレプリケーション の増分ロードタスクのSAP ECCソースと、データベース取り込みとレプリケーション の増分ロードタスクまたは初期ロードと増分ロードの組み合わせタスクのすべてのソースの場合、ジョブが初めて実行されたときに変更の読み取りを開始するソース変更ストリームまたはログ内の位置。
次のオプションがあります。
例:
restartPointForIncrementalLoad: earliest restartPointForIncrementalLoad: latest
データベース取り込みとレプリケーション タスクの場合、デフォルトはlatestです。
アプリケーション取り込みとレプリケーション タスクの場合、earliest オプションはサポートされていません。デフォルトは、restartPointForIncrementalLoadTimestampの値です。
このパラメータを指定する場合、restarPointForIncrementalLoadPositionパラメータまたはrestartPointForIncrementalLoadTimestampパラメータを一緒に指定しないでください。
restartPointForIncrementalLoadPosition
整数
データベース取り込みとレプリケーション の増分ロードタスクまたは初期ロードと増分ロードの組み合わせタスクのすべてのソースの場合、ジョブが初めて実行されたときに変更レコードの読み取りを開始するソース変更ストリームまたはログ内のRBA位置。
例:
restartPointForIncrementalLoadPosition: 0
このパラメータを指定する場合、restarPointForIncrementalLoadパラメータまたはrestartPointForIncrementalLoadTimestampパラメータを一緒に指定しないでください。
restartPointForIncrementalLoadTimestamp
タイムスタンプ
アプリケーション取り込みとレプリケーション の増分ロードタスク、またはデータベース取り込みとレプリケーション の初期ロードと増分ロードの組み合わせタスクのすべてのソースの場合、ジョブが初めて実行されたときに変更レコードの読み取りを開始するソース変更ストリームまたはログ内の日付と時刻（AMまたはPMを含む）。
例:
restartPointForIncrementalLoadTimestamp: 2021-08-18 02:50:00 PM
アプリケーション取り込みとレプリケーション タスクの場合、このパラメータによってデフォルトの動作が決まります。
注: このパラメータを指定する場合、restarPointForIncrementalLoadパラメータまたはrestartPointForIncrementalLoadPositionパラメータを一緒に指定しないでください。
cdcInterval
String（時間間隔）
アプリケーション取り込みとレプリケーション の増分ロードタスクまたは組み合わせロードタスクのSalesforceのソースの場合、CDCの変更レコードを取得するためにジョブが実行される時間間隔。
cdcIntervalDays、cdcIntervalHours、およびcdcIntervalMinsパラメータを指定できます。
fetchSize
整数
アプリケーション取り込みとレプリケーション の初期ロードタスクまたは増分ロードタスクのSalesforceのソースの場合、ジョブがソースから一度に読み取るレコードの数。
初期ロードジョブのデフォルト値は50000で、増分ロードジョブのデフォルト値は2000です。
salesforceAPIパラメータにStandard (REST) APIを指定した場合は、fetchSize値を2000に変更する必要があります。
fetchSizeForInitialLoad
整数
アプリケーション取り込みとレプリケーション の初期ロードと増分ロードの組み合わせタスクのSalesforceのソースの場合、初期アンロードフェーズでジョブが一度に読み取るソースレコードの数。
デフォルト値は50000です。
salesforceAPIフィールドに［Standard (REST) API］を指定した場合は、fetchSize値を2000に変更する必要があります。
fetchSizeForIncrementalLoad
整数
アプリケーション取り込みとレプリケーション の初期ロードと増分ロードの組み合わせタスクのSalesforceのソースの場合、増分フェーズでジョブがソースから一度に取得できる変更レコードの数。
デフォルト値は2000です。
初期ロードタスク、または初期ロードと増分ロードの組み合わせタスクで、salesforceAPIパラメータに［Standard (REST) API］を指定した場合は、fetchSize値を2000に更新する必要があります。
includeArchivedAndDeletedRows
ブール
アプリケーション取り込みとレプリケーション の初期ロードタスクまたは初期ロードと増分ロードの組み合わせタスクのSalesforceのソースの場合、初期ロード、または組み合わせロードのアンロードフェーズ中に、ジョブがソースからアーカイブ済みの行と論理削除された行を読み取ることができるかどうかを制御します。
デフォルトはfalseです。
includeBase64Fields
ブール
Salesforceソースを持つアプリケーション取り込みとレプリケーション タスクの場合、ジョブがBase64データ型を持つソースフィールドからデータをレプリケートできるかどうかを制御します。
デフォルトの値はfalseです。
このパラメータは、salesforceAPIパラメータを［Standard (REST) API］に設定した場合にのみ設定します。
maximumBase64BodySize
整数
アプリケーション取り込みとレプリケーション タスクのSalesforceのソースの場合、Base64でエンコードされたデータの最大ボディサイズ。
デフォルトは7MBです。
このパラメータは、includeBase64Fieldsフィールドをtrueに設定した場合にのみ渡します。
includeViews
ブール
データベース取り込みとレプリケーション タスクのMicrosoft SQL ServerおよびOracleのソースの場合、テーブル数やテーブル名のリストにビューを含めるかどうかを示します。
次のオプションがあります。
- true 。ビューを含めます。- false 。ビューを含めません。
次の表に、要求内のターゲット接続とタスクの属性を示します。
フィールド
タイプ
説明
接続
文字列
ターゲットシステムの接続の名前。
スキーマ
文字列
Amazon Redshift、Databricks、Google BigQuery、Microsoft Azure Synapse Analytics、Oracle、Snowflakeターゲットの場合、データ取り込みおよびレプリケーションによってターゲットオブジェクトまたはターゲットテーブルを作成するターゲットスキーマ。
bucket
文字列
Amazon Redshift、Google Cloud Storage、Google BigQueryターゲットの場合、ターゲットにロードするデータオブジェクトへのアクセスを保存、整理、制御する既存のバケットコンテナの名前。
directory
文字列
Databricks、Amazon Redshift、Google Cloud Storage、Google BigQueryターゲットの場合、データが含まれるターゲットオブジェクトの仮想ディレクトリ。
useTableNameAsTopicName
ブール
Apache Kafkaターゲットの場合、タスクががソースデータを含むメッセージを、ソーステーブルまたはソースオブジェクトごとに1つずつ個別のトピックに書き込むか、すべてのメッセージを1つのトピックに書き込むかを示します。
次のオプションがあります。
- true 。メッセージをテーブル固有の別のトピックに書き込みます。- false 。すべてのメッセージを、topicNameフィールドで指定された名前を持つ1つのトピックに書き込みます。includeSchemaName
ブール
Apache Kafkaターゲットで、かつuseTableNameAsTopicNameをtrueに設定している場合、この設定により、テーブル固有のトピック名にソーススキーマ名が追加されます。トピック名の形式はschemaname_tablenameになります。
次のオプションがあります。
- true 。テーブル固有のトピック名にソーススキーマ名が追加されます。- false 。テーブル固有のトピック名にソーススキーマ名が追加されません。tablePrefix
文字列
Apache Kafkaターゲットで、かつuseTableNameAsTopicNameをtrueに設定している場合、このパラメータは、テーブル固有のトピック名に追加するオプションのプレフィックスを指定します。
例えば、myprefix_を指定すると、トピック名の形式はmyprefix_tablenameになります。プレフィックスの後のアンダースコア（_）を省略すると、プレフィックスがテーブル名の前に追加されます。
tableSuffix
文字列
Apache Kafkaターゲットで、かつuseTableNameAsTopicNameをtrueに設定している場合、このパラメータは、テーブル固有のトピック名に追加するオプションのサフィックスを指定します。
例えば、_mysuffixを指定すると、トピック名の形式はtablename_mysuffixになります。サフィックスの前のアンダースコア（_）を省略すると、サフィックスがテーブル名に追加されます。
topicName
文字列
Apache Kafkaターゲットの場合、ソースデータを含むすべてのメッセージが書き込まれる単一のKafkaトピックの名前。useTableNameAsTopicNameがfalseに設定されている場合は、このパラメータを使用します。
stage
文字列
Apache Kafkaターゲットの場合、データがターゲットテーブルに書き込まれる前にソースから読み取られたデータを保持する内部ステージング領域の名前。この名前にスペースを含めることはできません。指定されたステージング領域が存在しない場合、自動的に作成されます。
outputFormat
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storage、Kafkaターゲットの場合、出力ファイルの形式。
次のオプションがあります。
デフォルトはCSVです。
注: CSV形式の出力ファイルでは、各フィールドの区切り文字として二重引用符（""）が使用されます。
parquetFormat
ブール
Amazon S3、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storage、Kafkaターゲットで、かつoutputFormatパラメータで出力形式としてAVROが指定されている場合、このパラメータをtrueに設定して、非圧縮Parquet形式でデータが書き込まれるようにします。または、outputFormatパラメータをPARQUETに設定し、このパラメータを含めないようにすることもできます。
次のオプションがあります。
- true 。非圧縮のParquet形式でデータを書き込みます。- false 。AVRO形式でデータを書き込みます。注: このオプションをtrueに設定した場合、Secure Agentが実行されているコンピュータにVisual Studio2013のVisual C++再配布可能パッケージをインストールする必要があります。
avroFormat
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storage、Kafkaターゲットで、かつ出力形式としてAVROが指定されている場合、ソーステーブルまたはソースオブジェクトごとに作成されるAvroスキーマの形式を指定します。
次のオプションがあります。
- Avro-Flat 。すべてのAvroフィールドを1つのレコードに一覧表示する場合に、このAvroスキーマ形式を使用します。- Avro-Generic 。このAvroスキーマ形式は、ソーステーブルまたはオブジェクトのすべてのカラムまたはフィールドをAvroフィールドの単一配列にリストします。- Avro-Nested 。各タイプの情報を個別のレコードに編成する場合に、このAvroスキーマ形式を使用します。デフォルトは［Avro-Flat］です。
avroSerializationFormat
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storage、Kafkaターゲットで、かつ出力形式としてAVROが指定されている場合、Avro出力ファイルのシリアル化形式を指定します。
次のオプションがあります。
デフォルト値は［Binary］です。
avroSchemaDirectory
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storage、Kafkaターゲットで、かつ出力形式としてAVROが指定されている場合、ソーステーブルまたはソースオブジェクトごとにデータ取り込みおよびレプリケーションがAvroスキーマ定義を保存するローカルディレクトリを指定します。
スキーマ定義ファイルの命名パターンは、schemaname_tablename.txtです。
注: このディレクトリを指定しない場合、Avroスキーマ定義ファイルは生成されません。
fixedDirectoryForEachTable
ブール
Amazon S3、Google Cloud Storage、またはMicrosoft Azure Data Lake Storage Gen2ターゲットを持つ初期ロードタスクの場合、タスクですべてのジョブ実行のソースデータが含まれるフラットファイルを書き込むディレクトリ名として、ソーステーブル名またはソースオブジェクト名を使用するかどうかを示します。
次のオプションがあります。
- true 。各ジョブ実行のディレクトリ名として、ソーステーブルまたはオブジェクト名を使用します。- false 。tablename_timestampという命名パターンを使用して、ジョブ実行ごとに新しいディレクトリのセットを作成します。fileCompressionType
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、AVROまたはCSV出力ファイルにオプションで使用できるファイル圧縮タイプ。
次のオプションがあります。
このパラメータを指定しない場合、出力ファイルは圧縮されません。
avroCompressionType
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Kafka、Microsoft Azure Data Lake Storageターゲットで、かつ出力形式がAVROに設定されている場合、オプションのAvro圧縮タイプ。
次のオプションがあります。
- None - Bzip2 - Deflate - Snappy デフォルトは［None］ で、これは圧縮が使用されないことを意味します。
parquetCompressionType
文字列
Amazon S3、フラットファイル、Google Cloud Storage、Kafka、Microsoft Azure Data Lake Storageターゲットの場合、parquetFormat trueパラメータで出力形式がPARQUETまたはAVROに設定されているときに使用するオプションのParquet圧縮タイプ。
次のオプションがあります。
deflateCompressionLevel
整数
Amazon S3、フラットファイル、Google Cloud Storage、Kafka、Microsoft Azure Data Lake Storageターゲットの場合、Deflate圧縮タイプ（avroCompressionTypeパラメータで設定）に使用する0-9の圧縮レベル。
デフォルトは0です。
addDirectoryTags
ブール
Amazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、タスクがHiveパーティション化の命名規則との互換性を確保するために適用サイクルディレクトリの名前に"dt="プレフィックスを追加するかどうかを示します。
次のオプションがあります。
- true 。適用サイクルディレクトリの名前に「dt=」プレフィックスを追加します。- false 。適用サイクルディレクトリの名前は変更しません。デフォルトはfalseです。
directoryTags
文字列
Amazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、このフィールドはaddDirectoryTagsフィールドに依存します。
例:
addDirectoryTags: true,
directoryTags: \directory.
renamingRules
リスト
ソーステーブルまたはソースオブジェクトに対応するターゲットテーブルの名前を変更するためのオプションのルール。
例:
- source: "*"
dataTypeRules
リスト
デフォルトのソースデータ型からターゲットデータ型へのマッピングルールを上書きするオプションのデータ型マッピングルール。デフォルトのマッピングは、『アプリケーション取り込みおよびレプリケーション』および『データベース取り込みおよびレプリケーション』ドキュメントの「デフォルトのデータ型マッピング」に記載されています。
例:
- source: Int target: String
cdcCompatibleFormat
ブール
Amazon S3、フラットファイル、Flatファイル、Google Cloud Storage、Kafka、Microsoft Azure Data Lake Storageターゲットの場合、出力にUNDOデータを含めるかどうかを示します。
デフォルトはfalseです。
次の表に、タスクに対して設定できるターゲット詳細属性を示します。
フィールド
タイプ
説明
addOperationType
ブール
増分ロードタスク、または初期ロードと増分ロードの組み合わせロードタスクのAmazon S3、Apache Kafka、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、このパラメータをtrueに設定して、ジョブがターゲットにレプリケートする出力内のソースSQL操作タイプが含まれるメタデータカラムを追加します。
増分ロードタスク、および初期ロードと増分ロードの組み合わせタスクの場合、デフォルトはtrueです。初期ロードタスクの場合、デフォルトはfalseです。
addOperationTime
ブール
増分ロードタスク、または初期ロードと増分ロードの組み合わせロードタスクのAmazon S3、Apache Kafka、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、このパラメータをtrueに設定して、ジョブがターゲットにレプリケートする出力内のソースSQL操作時間が含まれるメタデータカラムを追加します。初期ロードの場合、ジョブは常に現在の日付と時刻を書き込みます。デフォルトは、すべてのロードタイプでfalseです。
addOperationOwner
ブール
増分ロードタスク、または初期ロードと増分ロードの組み合わせロードタスクのAmazon S3、Apache Kafka、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、このパラメータをtrueに設定して、ジョブがターゲットにレプリケートする出力内のソースSQL操作の所有者が含まれるメタデータカラムを追加します。
初期ロードの場合、ジョブは常に所有者として「INFA」を書き込みます。デフォルトはfalseです。
addOperationTransactionId
ブール
増分ロードタスク、または初期ロードと増分ロードの組み合わせロードタスクのAmazon S3、Apache Kafka、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、このパラメータをtrueに設定して、ジョブがSQL操作のターゲットにレプリケートする出力内のソーストランザクションIDが含まれるメタデータカラムを追加します。
デフォルトはfalseです。
addBeforeImages
ブール
増分ロードタスクまたは組み合わせロードタスクのAmazon S3、Apache Kafka、フラットファイル、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、このパラメータをtrueに設定して、ジョブがターゲットに書き込む出力内にUNDOデータを含めるようにします。
デフォルトはfalseです。
asyncWrite
ブール
Kafkaターゲットの場合、Kafkaへのメッセージの同期配信を使用するかどうかを制御します。
次のオプションがあります。
- true 。非同期配信を使用します。データ取り込みおよびレプリケーションは、ソースから変更が取得された順序に関係なく、できるだけ早くメッセージを送信します。- false 。同期配信を使用します。Kafkaは、データ取り込みおよびレプリケーションが次のメッセージを送信する前に、各メッセージの受信を確認する必要があります。このモードでは、Kafkaが重複メッセージを受信する可能性はほとんどありません。ただし、パフォーマンスが低下する可能性があります。デフォルトはtrueです。
producerConfigurationProperties
文字列
Kafkaターゲットの場合、Apache Kafka、Confluent Kafka、またはKafka対応のEvent HubsターゲットのKafkaプロデューサプロパティを入力するための、key=valueペアのカンマ区切りリスト。
Confluent Schema Registryを使用してスキーマを格納するConfluentターゲットがある場合は、次のプロパティを指定する必要があります。
schema.registry.url=url, key.serializer= org.apache.kafka.common.serialization.StringSerializer, value.serializer= io.confluent.kafka.serializers.KafkaAvroSerializer
次の表に、タスクに対して設定できるランタイムオプションを示します。
フィールド
タイプ
説明
schemaDriftOptions
文字列
データベース取り込みとレプリケーション の増分ロードタスクまたは初期ロードと増分ロードの組み合わせタスクのMicrosoft SQL Server、Oracle、またはPostgreSQLソースの場合、DDL操作のスキーマドリフトオプション。
次のオプションがあります。
- addColumn - modifyColumn - dropColumn - renameColumn 有効な値は以下のとおりです。
- ignore - replicate - stop job - stop table 例:
schemaDriftOptions:
注: Microsoft Azure Synapse Analyticsのターゲットを持つタスクは、renameColumnオプションを無視します。
numberOfRowsInOutputFile
整数
Amazon Redshift、Amazon S3、Google Big Query、Google Cloud Storage、Microsoft Azure Data Lake Storage、Microsoft Azure Synapse Analytics、Oracle、Snowflakeターゲットの場合、タスクがターゲット上の出力データファイルに書き込む最大行数。
fileExtensionBasedOnFileType
ブール
フラットファイル、Amazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storageターゲットの場合、出力データファイルに.dat拡張子を付けるかどうかを示します。
- true 。出力ファイルには、ファイルタイプに基づいたファイル名拡張子が付きます。- false 。出力ファイルの拡張子は.datです。デフォルト値はtrueです。
applyCycleChangeLimit
整数
増分ロードタスクのAmazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、ジョブが適用サイクルを終了する前に処理する必要があるレコード数。このレコード制限に達すると、ジョブは適用サイクルを終了し、変更データをターゲットに書き込みます。
デフォルトは10000です。
注: applyCycleChangeLimitパラメータまたはapplyCycleIntervaltime_unitパラメータにはゼロ以外の値が必要です。
applyCycleIntervalDays
整数
増分ロードタスクのAmazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、アプリケーション取り込みおよびレプリケーションジョブまたはデータベース取り込みおよびレプリケーションジョブが適用サイクルを終了するまでに経過する必要がある日数。
applyCycleIntervalHours、applyCycleIntervalMins、およびapplyCycleIntervalSecsパラメータでこのパラメータを指定するか、これらのパラメータのサブセットを指定できます。
デフォルトは0です。
applyCycleIntervalHours
整数
増分ロードタスクのAmazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、ジョブが適用サイクルを終了する前に経過する必要がある時間数。
デフォルトは0です。
applyCycleIntervalMins
整数
増分ロードタスクのAmazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、アプリケーション取り込みおよびレプリケーションジョブまたはデータベース取り込みおよびレプリケーションジョブが適用サイクルを終了するまでに経過する必要がある分数。
デフォルトは15です。
applyCycleIntervalSecs
整数
増分ロードタスクのAmazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、アプリケーション取り込みおよびレプリケーションジョブまたはデータベース取り込みおよびレプリケーションジョブが適用サイクルを終了するまでに経過する必要がある秒数。
デフォルトは0です。
lowActivityFlushHours
整数
Amazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、アプリケーション取り込みおよびレプリケーションジョブまたはデータベース取り込みおよびレプリケーションジョブが適用サイクルを終了するまでに、ソース上で変更アクティビティのない期間中に経過する必要がある時間（時間単位）。
このパラメータをlowActivityFlushMinsパラメータと組み合わせて使用することも、これらのパラメータのいずれか1つだけを指定することもできます。この時間制限に達すると、ジョブは適用サイクルを終了し、変更データをターゲットに書き込みます。
デフォルトは0です。lowActivityFlushHoursまたはlowActivityFlushMinsの値を指定しない場合、アプリケーション取り込みおよびレプリケーションジョブまたはデータベース取り込みおよびレプリケーションジョブは、applyCycleChangeLimitまたはサイクル間隔の制限時間に達した後でのみ適用サイクルを終了します。
lowActivityFlushMins
整数
Amazon S3、Google Cloud Storage、Microsoft Azure Data Lake Storage Gen2ターゲットの場合、アプリケーション取り込みおよびレプリケーションジョブまたはデータベース取り込みおよびレプリケーションジョブが適用サイクルを終了するまでに、ソース上で変更アクティビティのない期間中に経過する必要がある時間（分単位）。
このパラメータをlowActivityFlushHoursパラメータと組み合わせて使用することも、これらのパラメータのいずれか1つだけを指定することもできます。全体の時間制限に達すると、取り込みおよびレプリケーションジョブは適用サイクルを終了し、変更データをターゲットに書き込みます。
デフォルトは0です。lowActivityFlushHoursまたはlowActivityFlushMinsの値を指定しない場合、ジョブは、applyCycleChangeLimitまたはサイクル間隔の制限時間に達した後でのみ適用サイクルを終了します。
次の表に、データ取り込みおよびレプリケーション時に進行状況がいつどのように保存されるのか定義するチェックポイント属性を示します。
フィールド
タイプ
説明
checkpointAllRows
ブール
増分ロードタスクのKafkaターゲットの場合、取り込みおよびレプリケーションジョブが、Kafkaターゲットに送信されるすべてのメッセージに対してチェックポイント処理を行うかどうかを示します。このパラメータがtrueに設定されている場合、checkpointEveryCommit、checkpointRowCount、およびcheckpointFrequencySecsパラメータは無視されます。
デフォルトはtrueです。
checkpointEveryCommit
ブール
増分ロードジョブのKafkaターゲットの場合、取り込みおよびレプリケーションジョブが、ソースで発生したすべてのコミットに対してチェックポイント処理を行うかどうかを示します。
デフォルトはfalseです。このパラメータをtrueに設定する場合、checkpointAllRowsを一緒に指定しないでください。
checkpointRowCount
整数
増分ロードタスクのKafkaターゲットの場合、チェックポイントを追加する前にジョブがターゲットに送信する最大メッセージ数。
このオプションを0に設定すると、取り込みおよびレプリケーションジョブはメッセージの数に基づいてチェックポイント処理を実行しません。このオプションを1に設定すると、取り込みおよびレプリケーションジョブは各メッセージにチェックポイントを追加します。
デフォルトは0です。このパラメータをゼロ以外の数に設定する場合、checkpointAllRowsを一緒に指定しないでください。
checkpointFrequencySecs
整数
増分ロードタスクのKafkaターゲットの場合、取り込みおよびレプリケーションジョブがチェックポイントを追加する前に経過する必要のある最大秒数。このオプションを0に設定すると、ジョブは経過時間に基づいてチェックポイント処理を実行しません。
デフォルトは0です。このパラメータをゼロ以外の数に設定する場合、checkpointAllRowsを一緒に指定しないでください。
次の表に、タスクに対して設定できるカスタム属性とスケジュール属性を示します。
フィールド
タイプ
説明
customProperties
文字列
特別な要件を満たす他目にInformaticaが提供するソース、ターゲット、タスク定義のカスタムプロパティ。これらのプロパティを指定する場合は、Informaticaグローバルカスタマサポートにお問い合わせください。
例:
"customProperties": {
schedule
文字列
デプロイ後に初期ロードタスクのジョブインスタンスを実行するために、Administratorで事前定義したスケジュールの名前。
成功POST応答 タスクが正常に作成された場合、APIは201「作成済み」成功コードを返します。応答には通常は次のヘッダーが含まれています。
Content-Type: application/json;charset=UTF-8
また、応答にはタスクに関する次の情報も含まれています。
フィールド
タイプ
説明
location
文字列
タスクの作成先となるプロジェクト名とフォルダ名。
taskId
文字列
新規作成したタスクに対して生成されたID。
frsId
文字列
FRS参照ID。
名前
文字列
タスクの名前。
説明
文字列
タスクの説明。
createdBy
文字列
タスクを作成したユーザーのID。
documentType
文字列
ドキュメントタイプ: 要求で指定したtaskType値に基づき、DBMI_TASKまたはAPPMI_TASK。
parentInfo
文字列
親プロジェクトと構造の詳細。
初期ロードタスクの例 POST要求
データベース取り込みとレプリケーション タスクを作成する際にはこの例を参考にしてください。
{
POST応答
POST応答が成功すると、次に示す初期ロードジョブの例と同様のサマリが返されます。
{
増分ロードタスクの例 POST要求
データベース取り込みとレプリケーション の増分ロードジョブを作成する際にはこの例を参考にしてください。
{
POST応答
POST応答が成功すると、次に示す増分ロードジョブの例と同様のサマリが返されます。
{
組み合わせロードタスクの例 POST要求
データベース取り込みとレプリケーション の組み合わせロードジョブを作成する際にはこの例を参考にしてください。
{
POST応答
POST応答が成功すると、次に示す組み合わせロードジョブの例と同様のサマリが返されます。
{
失敗応答とエラーコード 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返すことがあります。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
禁止されています
403
ログインしたユーザーには、タスクを作成する権限または指定したフォルダにアクセスする権限がありません。
内部サーバーエラー
500
内部サービスエラーのため、失敗しました。
データベース取り込みおよびレプリケーションタスクとアプリケーション取り込みおよびレプリケーションタスクのデプロイ デプロイリソースを使用して、データベース取り込みとレプリケーション タスクまたはアプリケーション取り込みとレプリケーション タスクをデプロイします。
タスクをデプロイするには、次のタスクを実行します。
• • タスクIDの取得 タスクをデプロイする前に、タスクIDを取得する必要があります。
次のGET要求を使用してタスクIDを取得します。
GET /dbmi/public/api/v2/tasks/fetchId?taskName={taskName}&projectId={projectId}&folderId={folderId}
要求には次のようなオプションの属性を含めることができます。
フィールド
タイプ
説明
projectId
string
タスクが存在するプロジェクトのID。
folderId
string
タスクが存在するプロジェクト内のフォルダのID。
taskName
string
タスクの名前。
プロジェクトID、フォルダID、およびタスク名の取得 次のいずれかの方法を使用して、デプロイするタスクのプロジェクトID、フォルダID、およびタスク名を取得できます。
FRS APIを使用し、タスク名でドキュメントをフィルタリングしてフォルダIDとプロジェクトIDを取得します。
GET /frs/api/v1/Documents?$filter=name eq 'taskName'
例:
https://pod.ics.dev:444/frs/api/v1/Documents?$filter=name eq 'zendeskToSlfk'
または、次のようにタスクユーザーインタフェースから詳細を取得することもできます。
• ［参照］ に移動して、プロジェクトを選択します。プロジェクトIDはURLに表示されています。• • Administrator > ［ランタイム環境］ に移動し、タスクで使用するランタイム環境を選択して、URLに表示されるIDをコピーします。サンプル要求 次のサンプルを参考にしてタスクIDを取得します。
GET https://pod-ing.ics.dev:11447/dbmi/public/api/v2/tasks/fetchId?projectId=1lHbX3urKB8dHJ071tXV8Fg&folderId=5GX14m3CuFAeVWqnsSX9mC&taskName=zendeskToSlfk
サンプル応答 成功応答では、次の例のようにタスク名とタスクIDを含むサマリが返されます。
{
ページネーション属性 結果をページ分けするために、GET要求に次のページネーション属性を含めることができます:
GET /dbmi/public/api/v2/task/fetchId?orderBy={nameOfThecolumn}&pageNo={int}&pageSize={int}
要求には次のようなページネーション属性を含めることができます。
フィールド
タイプ
説明
orderBy
string
結果をソートするカラム名。
次のいずれかのカラム名を使用して、ソート順を指定できます。
- - - - pageNo
整数
ページネーション後に取得するページ番号。
pageSize
整数
ページあたりのレコード数。
タスクのデプロイ taskID を取得したら、デプロイリソースを使用してタスクをデプロイします。
次のPOST要求を使用してタスクをデプロイします。
POST /dbmi/public/api/v2/task/deploy/{taskId}
要求に次の属性を含めます。
フィールド
タイプ
説明
taskId
integer
タスクに関連付けられたID。
サンプル応答 デプロイ要求が成功すると、ジョブIDとデプロイステータスを含むサマリとともに、デプロイが開始されたことを示す202ステータスコードが返されます。
注: デプロイは非同期で実行されます。多くのテーブルが含まれるタスクでは、デプロイに時間がかかることがあります。APIは即座に「デプロイメントが開始されました」というメッセージで応答します。ステータスを監視するには、ジョブIDでGet Status Status APIにクエリを実行してください。詳細については、「Get Job Status API」を参照してください。
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返すことがあります。
名前
HTTPステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
不正な要求です
400
本文がありません。
禁止されています
403
タスクをデプロイする権限がありません。
見つかりません
404
一括取り込みデータベースは、IDでタスクを見つけることができませんでした。
デプロイメントの競合
409
一括取り込みタスクはすでにデプロイされています。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
データベース取り込みおよびレプリケーションジョブとアプリケーション取り込みおよびレプリケーションジョブの実行 ジョブリソースを使用して、データベース取り込みとレプリケーション ジョブまたはアプリケーション取り込みとレプリケーション ジョブを実行します。
タスクを実行して監視するには、次のタスクを実行します。
• • ジョブIDの取得 ジョブを開始するにはジョブIDを取得する必要があります。
次のGET要求を使用してジョブIDを取得します。
GET /dbmi/public/api/v2/task/fetch/{taskId}/job
要求に次の属性を含めます。
フィールド
タイプ
説明
taskId
integer
デプロイ済みタスクのID。
サンプル要求 次のサンプルを参考にしてジョブIDを取得します。
GET https://pod-ing.ics.dev:11447/dbmi/public/api/v2/task/fetch/2/job
サンプル応答 成功応答では、次の例のように指定したタスクIDのジョブIDとそれに関連する詳細が返されます。
指定したタスクIDに対して1つのジョブIDのみが返されます。
ジョブの開始 ジョブIDを使用してジョブインスタンスを開始します。
次のPOST要求を使用してタスクを実行します。
POST /dbmi/public/api/v2/job/start
要求本文に次の属性を含めます。
フィールド
タイプ
説明
jobId
integer
開始するジョブのID。
サンプル本文 次の要求本文を使用して、ジョブIDをリソースに渡します。
{
各タスクは1つのジョブIDに対応します。したがって、特定のタスクのジョブIDを取得すると、返されるジョブIDは1つだけです。
サンプル応答 成功応答では、ジョブの開始が承認されたことを示す202ステータスコードが返されます。
注: ジョブ開始APIは非同期でジョブを開始します。応答により、ジョブの開始が承認されたことが確認されますジョブが正常に開始されたかどうか確認し、進行状況を監視するには、ジョブステータスAPIをクエリしてください。詳細については、「Get Job Status API」を参照してください。
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返すことがあります。
名前
HTTPステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
禁止されています
403
実行または開始する権限がありません。
ジョブIDなし
404
一括取り込みデータベースは、IDが'0'のジョブを見つけることができませんでした。
見つかりません
404
一括取り込みデータベースは、IDが'<jobId>'のジョブを見つけることができませんでした。
開始が競合しています。
409
ジョブは既に実行中です。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
データベース取り込みおよびレプリケーションジョブとアプリケーション取り込みおよびレプリケーションジョブの停止 ジョブリソースの停止アクションを使用して、「稼動中」、「実行中（警告あり）」、または「保留中」のステータスを持つデータベース取り込みとレプリケーション ジョブまたはアプリケーション取り込みとレプリケーション ジョブを停止します。
POST要求 ジョブを停止するには、次のPOST要求を使用します。
POST /dbmi/public/api/v2/job/stop
要求本文に次の属性を含めます。
フィールド
タイプ
説明
jobId
integer
停止するジョブのID。
要求本文 次の要求本文を使用して、ジョブIDをリソースに渡します。
{
成功応答 成功応答は、ジョブの停止が承認されたことを示すステータスを返します。
{
注: ジョブ停止APIは要求を非同期で処理します。ジョブが正常に停止したかどうかを確認するには、ジョブIDを指定してジョブステータス取得APIをクエリしてください。詳細については、「Get Job Status API」を参照してください。
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返すことがあります。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
不正な要求です
400
本文がありません。
禁止されています
403
ジョブを停止する権限がありません。
ジョブIDなし
404
一括取り込みデータベースは、IDが'0'のジョブを見つけることができませんでした。
見つかりません
404
一括取り込みデータベースは、IDが'<jobId>'のジョブを見つけることができませんでした。
重複
409
ジョブIDに関連付けられたジョブが"RUNNING"状態ではありません。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
データベース取り込みおよびレプリケーションタスクとアプリケーション取り込みおよびレプリケーションタスクの再開 ジョブリソースの再開アクションを使用して、スキーマドリフトエラーが原因で失敗、停止、または中止したデータベース取り込みとレプリケーション ジョブまたはアプリケーション取り込みとレプリケーション ジョブを再開します。
POST要求 ジョブを再開するには、次のPOST要求を使用します。
POST /dbmi/public/api/v2/job/resume
要求本文に次の必須の属性を含めてください。
フィールド
タイプ
説明
jobId
integer
再開するジョブのID。
parameters
Map<String, JSON>
スキーマドリフトオプションを上書きし、停止、中止、失敗状態にあるジョブの再開方法を制御します。
増分ロードジョブの場合、再開オプションは次のとおりです。
- replicate 。ジョブがDDL変更をターゲットにレプリケートできるようにします。- ignore 。ソースデータベースで発生するDDLの変更をターゲットにレプリケートしません。- stop 。DDL変更が発生したソーステーブルの処理を停止します。組み合わせロードジョブの場合、再開オプションは次のとおりです。
- replicate 。ジョブがDDL変更をターゲットにレプリケートできるようにします。- ignore 。ソースデータベースで発生するDDLの変更をターゲットにレプリケートしません。- stop table 。DDL変更が発生したソーステーブルの処理を停止します。- resync retain 。CDC用に処理されたのと同じカラムを再同期し、ソーステーブルとターゲットテーブルの現在の構造を保持します。ソーステーブル定義またはターゲットテーブル定義の変更のチェックは行われません。ソースDDLの変更がソーステーブル構造に影響を与えた場合、それらの変更は処理されません。- resync 。DDL変更をターゲットにレプリケートします。
要求本文 再開オプションなしで属性を渡すには、次の要求本文を使用します。
{
再開オプションありで属性を渡すには、次の要求本文を使用します。この例には、すべてのスキーマ変更をレプリケートする再開オプションが含まれています。
{
注: RESYNCまたはRESYNC_RETAIN再開オプションを指定すると、APIは自動的に汎用パターン"*.*"をresyncPatternsに適用するため、ユーザーがパターンを明示的に指定する必要はありません。IGNORE、REPLICATE、およびSTOP_TABLE再開オプションの場合、APIはresumeOptionsフィールドで指定したパターンを使用します。APIは、DROP_COLUMN、ADD_COLUMN、RENAME_COLUMN、MODIFY_COLUMNなどのスキーマ操作用のSchemaDriftItemsのリストが含まれたパターンに対するSchemaChangeHandlingOptionを作成します。各操作は再開アクションから派生した対応するSchemaDriftActionにマッピングされます。
例:
{
この要求では、sales スキーマ内のすべてのテーブルがスキーマ変更をレプリケートします。
成功応答 成功応答は成功ステータスを返します。これは、ジョブの再開が承認されたことを示します。
{
注: ジョブ再開APIは要求を非同期で処理します。ジョブが正常に再開されたかどうかを確認するには、ジョブIDを指定してジョブステータス取得APIをクエリしてください。詳細については、「Get Job Status API」を参照してください。
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返します。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
不正な要求です
400
本文がありません。
禁止されています
403
ジョブを再開する権限がありません。
ジョブIDなし
404
一括取り込みデータベースは、IDが'0'のジョブを見つけることができませんでした。
見つかりません
404
一括取り込みデータベースは、IDが'<jobId>'のジョブを見つけることができませんでした。
重複
409
すでに実行中であるか、"COMPLETED"または"DEPLOYED"状態であるため、開始できません。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
データベース取り込みおよびレプリケーションジョブとアプリケーション取り込みおよびレプリケーションジョブのデプロイ解除 ジョブリソースのデプロイ解除アクションを使用して、データベース取り込みとレプリケーション ジョブまたはアプリケーション取り込みとレプリケーション ジョブをデプロイ解除します。ジョブをデプロイ解除する前に、そのジョブが実行中でなく、ステータスがAborted、Completed、Deployed、Failed、またはStoppedであることを確認してください。
POST要求 ジョブをデプロイ解除するには、次のPOST要求を使用します。
POST /dbmi/public/api/v2/job/undeploy
要求本文に次の属性を含めます。
フィールド
タイプ
説明
jobId
integer
デプロイ解除するジョブのID。
要求本文 次の要求本文を使用して、ジョブIDをリソースに渡します。
{
成功応答 成功応答では、ジョブのデプロイ解除が承認されたことを示す成功ステータスが返されます。
{
注: ジョブデプロイ解除APIは要求を非同期で処理します。ジョブが正常にデプロイ解除されたかどうかを確認するには、ジョブIDを指定してジョブステータス取得APIをクエリしてください。詳細については、「Get Job Status API」を参照してください。
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返します。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
不正な要求です
400
本文がありません。
禁止されています
403
デプロイ解除する権限がありません。
ジョブIDなし
404
一括取り込みデータベースは、IDが'0'のジョブを見つけることができませんでした。
見つかりません
404
一括取り込みデータベースは、IDが'<jobId>'のジョブを見つけることができませんでした。
重複
409
ジョブIDに関連付けられたジョブが"STOPPED"、"FAILED"、または"ABORTED"状態ではありません。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
データベース取り込みおよびレプリケーションタスクまたはアプリケーション取り込みおよびレプリケーションタスクのジョブステータスの取得 ジョブリソースのステータスアクションを使用して、データベース取り込みとレプリケーション ジョブまたはアプリケーション取り込みとレプリケーション ジョブのステータスを取得します。
GET要求 ジョブのステータスを取得するには、次のGET要求を使用します。
GET /dbmi/public/api/v2/job/status
要求本文に次の属性を含めます。
フィールド
タイプ
説明
jobId
integer
ステータスを取得するジョブのID。
要求本文 次の要求本文を使用して、ジョブIDをリソースに渡します。
{
GET応答 成功した場合、応答には、ジョブのステータスに関する次の情報が含まれます。
フィールド
タイプ
説明
jobId
Long
ジョブの一意の識別子。
assetName
String
タスクの名前。
assetType
文字列
アセットのタイプまたはカテゴリ。要求で指定したタスクタイプに応じて、APPMI_TASKまたはDBMI_TASKを返します。
startedBy
文字列
ジョブを開始したユーザーの電子メールアドレスまたは識別子。
orgId
文字列
ジョブが属する組織の識別子。
runtimeEnv
文字列
ジョブを実行するランタイム環境の名前。
status
文字列
ジョブのステータス。ジョブは、次のいずれかのステータスになります。
- 稼働中 。ジョブは実行中です。- 実行中（警告あり） 。ジョブは実行中ですが警告があります。この状態は、1つ以上のテーブル固有サブタスクが失敗し、一部のサブタスクが実行中であるときにも発生します。- 保留 。DBMIエージェントの更新中にジョブが一時停止状態になっています。- 停止中 。停止要求への応答として、ジョブを停止中です。- 停止 。ジョブが意図的に停止されました。- 失敗 。ジョブは異常終了しました。ジョブへのタスクデプロイメントが失敗したか、1つ以上のテーブル固有サブタスクが失敗しました。また、初期ロードジョブの場合は、ジョブが停止しました。- デプロイ中 。ジョブはデプロイ中です。- デプロイ 。ジョブはデプロイされました。- 強制終了中 。強制終了要求への応答として、ジョブが直ちに停止されようとしている状態です。- 強制終了 。ジョブは強制終了されました。- デプロイ解除中 。ジョブはデプロイ解除中です。- デプロイ解除 。ジョブはデプロイ解除されました。- 完了 。ジョブが正常に完了しました。durationInSeconds
Long
ジョブ実行時間（秒単位）。
endTime
String（ISO 8601）
ジョブが終了した時刻のタイムスタンプ。
location
文字列
タスク定義を含むプロジェクトまたはプロジェクトフォルダ。
startTime
String（ISO 8601）
ジョブが開始した時刻のタイムスタンプ。
errorMessage
StringまたはNULL
ジョブが失敗した場合のエラーメッセージ。エラーがない場合はNULLです。
lastAction
文字列
ジョブで最後に実行されたアクションの説明。例えば、ジョブがユーザーによって開始されたなどです。
jobConfig
Object（JobInfoExtraData）
ジョブに関連付けられたタスクに関連する設定の詳細。
jobConfigパラメータには次の情報が含まれています。
フィールド
タイプ
説明
taskId
文字列
ジョブに関連付けられたタスクの一意の識別子。
taskMode
String（Enum）
実行されたロード操作のタイプを表します。次のオプションがあります。
- UNLOAD 。ある時点で読み取られたソースデータをターゲットにロードします。データがロードされると、取り込みおよびレプリケーションジョブは終了します。- CDC 。データの変更を継続的に、または取り込みおよびレプリケーションジョブが停止または終了するまでロードします。ジョブは、最後に実行されてから、または特定の開始点から発生した変更をロードします。- COMBINED 。ターゲットへのポイントインタイムデータの初期ロードを実行してから、同じソースオブジェクトに対して継続的に行われた増分データ変更のプロパゲートに自動的に切り替わります。srcConnId
文字列
タスクで使用されるソース接続識別子。
tgtConnId
文字列
タスクで使用されるターゲット接続識別子。
deployTime
String（ISO 8601）
タスクがデプロイされた時刻のタイムスタンプ。
schedulerJobName
StringまたはNULL
該当する場合はスケジューラジョブの名前。スケジュールされていない場合はNULLです。
schedulerId
文字列
スケジューラのURL。該当しない場合は空の文字列を返します。
agentId
文字列
ジョブのデプロイメントを処理するエージェントの識別子。割り当てられていない場合は空を返します。
isRunOnOtherAgentEnabled
Boolean
ジョブを他のエージェントで実行可能かどうかを示すフラグ。
isServerless
BooleanまたはNULL
ジョブがサーバーレス環境で実行されているかどうかを示します。
deployVersion
文字列
デプロイメントのバージョン。例: 58.0.0-SNAPSHOT。
featureTags
ListまたはNULL。
ジョブに関連付けられた機能タグのリスト。ない場合はNULLを返します。
srcVendor
StringまたはNULL
ベンダーまたはソースシステムのタイプ。例: ZENDESK。
tgtVendor
StringまたはNULL
ベンダーまたはターゲットシステムのタイプ。例: SNOWFLAKE。
cdcGroupJobId
LongまたはNULL
CDCグループジョブID。このパラメータはCDCおよび組み合わせジョブの場合にのみ返されます。
cdcGroupInmdtStrgConId
StringまたはNULL
CDCグループ中間ストレージ接続ID。このパラメータはCDCおよび組み合わせジョブの場合にのみ返されます。
mapOfApplyJobDetails
Map<String, Object>
CDCステージングジョブの適用ジョブと、CDCステージンググループへの移行ジョブに対するジョブのマップ。
成功応答の例 成功応答では、次の例のようなジョブステータスに関する詳細が返されます。
{
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返すことがあります。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
不正な要求です
400
本文がありません。
禁止されています
403
権限なし。
見つかりません
404
一括取り込みデータベースは、IDが'<jobId>'のジョブを見つけることができませんでした。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
データベース取り込みおよびレプリケーションジョブまたはアプリケーション取り込みおよびレプリケーションジョブの統計の取得 ジョブリソースのメトリックアクションを使用して、データベース取り込みとレプリケーション ジョブまたはアプリケーション取り込みとレプリケーション ジョブの詳細な統計を取得します。
POST要求 詳細なジョブ統計を取得するには、次のPOST要求を使用します。
POST /dbmi/public/api/v2/job/metrics
要求本文に次の必須の属性を含めてください。
フィールド
タイプ
説明
jobId
integer
詳細なジョブ統計を取得するジョブのID。
パラメータ
Map<String,json>
metricsOptionsとその値が含まれるマップ。
次の必須のmetricsOptions属性を含めてください。
フィールド
タイプ
説明
stateFilter
string
メトリックを取得するオブジェクトの状態に対するフィルタ。null を指定すると、フィルタリングは適用されません。
sort
array
結果のソート順を定義します。例えば、"srcTable" を昇順（"asc" ）でソートするには、次の属性を渡します: "
"sort": [ "srcTable", "asc" ],
search
string
名前またはその他の検索可能なフィールドでオブジェクトをフィルタリングするための検索文字列。空の文字列の場合は、フィルタが適用されないことを表します。
offset
number
1つの応答またはページサイズで返すオブジェクトの最大数。例えば、offsetを25に設定すると、要求は1つの応答で最大25個のオブジェクトのメトリックを返すことができます。
limit
数値
ページネーションのために先頭からスキップするオブジェクトの数。例えば、0は先頭のオブジェクトから開始することを意味します。
要求本文 次の要求本文を使用して、ジョブIDとメトリックオプションを渡します。
{
成功応答 成功応答には、ジョブとそのタスクに関する次の詳細な統計が含まれます。
パラメータ
タイプ
説明
jobId
Long
ジョブの一意の識別子。
assetId
文字列
ジョブに関連するアセット識別子。
jobName
文字列
ジョブの名前。
assetType
文字列
アセットのタイプまたはカテゴリ。アセットタイプは、指定したタスクタイプに応じて"APPMI_TASK"または"DBMI_TASK"です。
startedBy
文字列
ジョブを開始したユーザーの電子メールアドレスまたは識別子。
correlationId
文字列
関連するジョブやプロセスを追跡するための相関識別子。
orgId
文字列
ジョブが属する組織の識別子。
runtimeEnv
文字列
ジョブを実行するランタイム環境の名前。
ステータス
文字列
ジョブのステータス。次のオプションがあります。
- 稼働中 。ジョブは実行中です。- 実行中（警告あり） 。ジョブは実行中ですが警告があります。この状態は、1つ以上のテーブル固有サブタスクが失敗し、一部のサブタスクが実行中であるときにも発生します。- 保留 。データベース取り込みおよびレプリケーション（DBMI）エージェントの更新中にジョブが一時停止状態になっています。- 停止中 。停止要求への応答として、ジョブを停止中です。- 停止 。ジョブが意図的に停止されました。- 失敗 。ジョブは異常終了しました。ジョブへのタスクデプロイメントが失敗したか、1つ以上のテーブル固有サブタスクが失敗しました。また、初期ロードジョブの場合は、ジョブが停止しました。- デプロイ中 。ジョブはデプロイ中です。- デプロイ 。ジョブはデプロイされました。- 強制終了中 。強制終了要求への応答として、ジョブが直ちに停止されようとしている状態です。- 強制終了 。ジョブは強制終了されました。- デプロイ解除中 。ジョブはデプロイ解除中です。- デプロイ解除 。ジョブはデプロイ解除されました。- 完了 。ジョブが正常に完了しました。duration
Long
ジョブ実行時間（ミリ秒または秒単位）。
endTime
String（ISO 8601 timestamp）
ジョブが終了した時刻のタイムスタンプ。
startTime
String（ISO 8601 timestamp）
ジョブが開始した時刻のタイムスタンプ。
location
文字列
タスク定義を含むプロジェクトまたはフォルダ。
jobConfig
オブジェクト
ジョブタスクに関連する設定の詳細。
metricsInfo
List
ジョブに関連付けられた各タスクのメトリックのリスト。
jobConfigパラメータには次の情報が含まれています。
パラメータ
タイプ
説明
taskId
文字列
ジョブに関連付けられたタスクの一意の識別子。
taskMode
String（Enum）
実行されたロード操作のタイプを表します。
次のオプションがあります。
- UNLOAD 。ある時点で読み取られたソースデータをターゲットにロードします。データがロードされると、取り込みおよびレプリケーションジョブは終了します。- CDC 。データの変更を継続的に、または取り込みおよびレプリケーションジョブが停止または終了するまでロードします。ジョブは、最後に実行されてから、または特定の開始点から発生した変更をロードします。- COMBINED 。ターゲットへのポイントインタイムデータの初期ロードを実行してから、同じソースオブジェクトに対して継続的に行われた増分データ変更のプロパゲートに自動的に切り替わります。srcConnId
文字列
タスクで使用されるソース接続識別子。
tgtConnId
文字列
タスクで使用されるターゲット接続識別子。
deployTime
String（ISO 8601）
タスクがデプロイされた時刻のタイムスタンプ。
schedulerJobName
StringまたはNULL
該当する場合はスケジューラジョブの名前。スケジュールされていない場合はNULLです。
schedulerId
文字列
スケジューラのURL。該当しない場合は空の文字列を返します。
agentId
文字列
ジョブのデプロイメントを処理するエージェントの識別子。割り当てられていない場合は空を返します。
isRunOnOtherAgentEnabled
ブール
ジョブを他のエージェントで実行可能かどうかを示すフラグ。
isServerless
BooleanまたはNULL
ジョブがサーバーレス環境で実行されているかどうかを示します。
deployVersion
文字列
デプロイメントのバージョン。例: 58.0.0-SNAPSHOT。
featureTags
ListまたはNULL。
ジョブに関連付けられた機能タグのリスト。ない場合はNULLを返します。
srcVendor
StringまたはNULL
ベンダー名またはソースシステム名。例: ORACLE。
tgtVendor
StringまたはNULL
ベンダー名またはターゲットシステム名。例: SNOWFLAKE。
cdcGroupJobId
LongまたはNULL
CDCグループジョブID。データベース取り込みとレプリケーション CDCステージングタスクの場合はこのパラメータを返します。
cdcGroupInmdtStrgConId
StringまたはNULL
CDCグループ中間ストレージ接続ID。データベース取り込みとレプリケーション CDCステージングタスクの場合はこのパラメータを返します。
mapOfApplyJobDetails
Map<String, Object>
データベース取り込みとレプリケーション CDCステージングジョブの適用ジョブのマップ、およびCDCステージンググループへの移行ジョブのマップ。
metricsInfoパラメータには次の情報が含まれています。
パラメータ
タイプ
説明
jobName
文字列
ジョブの名前。
taskName
文字列
ジョブに関連付けられたタスクの名前。
runId
文字列
タスク実行の実行ID。
recordsRead
Long
タスク中に読み取られたレコードの数。
recordsWritten
Long
タスク中に書き込まれたレコードの数。
captureProgress
ObjectまたはNULL
オプションの進行状況キャプチャオブジェクト。該当しない場合はNULLです。
duration
Long
タスク実行時間（通常はミリ秒単位）。
subTasks
リスト
このタスクに関連するサブタスクのメトリックのリスト。
アンロードメトリックのサンプル応答 次のサンプル応答では、返されたアンロードメトリックが示されています。
{
CDCメトリックのサンプル応答 次のサンプル応答では、返されたCDCメトリックが示されています。
{
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返すことがあります。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
不正な要求です
400
本文がありません。
禁止されています
403
権限なし。
見つかりません
404
一括取り込みデータベースは、IDが'<jobId>'のジョブを見つけることができませんでした。
重複
409
ステータス収集対象の一括取り込みジョブが有効状態ではありません。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。
内部サーバーエラー
500
requestBodyにMetricsOptionsがありません。
データベース取り込みおよびレプリケーションタスクまたはアプリケーション取り込みおよびレプリケーションタスクの詳細の取得 タスクリソースの詳細アクションを使用して、組織内のデータベース取り込みとレプリケーション タスクまたはアプリケーション取り込みとレプリケーション タスクに関する詳細情報を取得します。このAPIは詳細なタスクペイロード情報を提供します。その情報はタスクの作成または更新時に簡単に再利用できます。
GET要求 タスクの詳細を取得するには、次のGET要求を使用します。
GET /dbmi/public/api/v2/task/details?taskId={taskId}&projectId={projectId}&folderId={folderId}
要求パラメータ URLにタスクIDを含めると、特定のタスクの詳細を取得することができます。また、URLでプロジェクトIDとフォルダIDを指定すると、特定のプロジェクトとフォルダ内のすべてのタスクの詳細を取得できます。タスクID、プロジェクトID、およびフォルダIDを省略すると、APIは組織内のすべてのタスクの詳細を返します。
フィールド
タイプ
説明
projectId
文字列
タスクが存在するプロジェクトのID。
folderId
文字列
タスクが存在するプロジェクト内のフォルダのID。
taskId
integer
タスクのID。
要求には次のようなオプションのページネーション属性を含めることもできます。
フィールド
タイプ
説明
orderBy
string
結果をソートするカラム名。
次のいずれかのカラム名を使用して、ソート順を指定できます。
- - - - pageNo
整数
ページネーション後に取得するページ番号。
pageSize
整数
ページあたりのレコード数。
GET要求 ページネーションなし
ページネーションなしでタスクID、プロジェクトID、およびフォルダIDに基づいてタスクの詳細を取得するには、次のGET要求を使用します。
GET /dbmi/public/api/v2/task/details?taskId={taskId}&projectId={projectId}&folderId={folderId}
例:
GET https://pod-ing.ics.dev:11447/dbmi/public/api/v2/task/details?taskId=2&folderId=5GX14m3CuFAeVWqnsSX9mC
ページネーションあり
結果をページ分けするために、GET要求に次のパラメータを含めることができます:
GET /dbmi/public/api/v2/task/details?orderBy={nameOftheColumn}&pageNo={int}&pageSize={int}
例:
GET https://pod-ing.ics.dev:11447/dbmi/public/api/v2/task/details?orderBy=name&pageNo=2&pageSize=1
成功応答 成功応答ではHTTPステータスコード200が返され、次のヘッダーが含まれます。
Content-Type: application/json
応答に含まれるフィールド 応答には、次のフィールドを含めたタスクの詳細が含まれます。
フィールド
タイプ
説明
totalCount
int
応答で返されたドキュメントの総数。
ドキュメント
オブジェクトリスト
それぞれがタスクまたはアセットを表すドキュメントオブジェクトのリスト。
それぞれのドキュメント オブジェクトには次のフィールドが含まれます。
フィールド
タイプ
説明
taskId
int
repoInfo.repoHandleから取得したタスクの識別子。
名前
string
ドキュメントまたはタスクの名前。
documentState
string
ドキュメントの現在の状態（VALIDなど）。
documentType
string
ドキュメントのタイプ。例: APPMI_TASKまたはDBMI_TASK。
parentInfo
オブジェクトリスト
ドキュメントに関連する親エンティティ（スペース、プロジェクト、フォルダなど）のリスト。
説明
string
ドキュメントの説明。このフィールドは空にすることができます。
owner
string
ドキュメントの所有者の識別子。
createdBy
string
ドキュメントを作成したユーザーの識別子。
createdTime
string（ISO 8601）
ドキュメント作成時刻を示すタイムスタンプ。
accessedTime
string（ISO 8601）
ドキュメントに最後にアクセスした時刻を示すタイムスタンプ。
updateTime
string（ISO 8601）
ドキュメントの最終更新時刻を示すタイムスタンプ。
dbmiTask
JSONノード
タスク固有の設定とメタデータを含む詳細なJSONオブジェクト。
nativeData
NativeData
ドキュメントに関連付けられているオプションのネイティブデータ。値はNULLにすることができます。
contentType
string
ドキュメントのコンテンツタイプ。JSONのシリアル化時は無視されます。
docRef
DocRef
リポジトリ内のドキュメントへの参照。値はNULLにすることができます。
repoInfo
RepositoryInfo
リポジトリハンドルなど、リポジトリ関連の情報。値はNULLにすることができます。
ParentInfo オブジェクトには次のフィールドが含まれます。
フィールド
タイプ
説明
parentId
string
スペース、プロジェクト、フォルダなど、親エンティティの識別子。
parentName
string
親エンティティの名前。
parentType
string
親エンティティのタイプ（スペース、プロジェクト、フォルダなど）。
ページネーションなしのサンプル応答 次の例は、ページネーションなしで単一のタスクに対して返される詳細情報を示します。
{
ページネーションありのサンプル応答 次の例は、複数のタスクドキュメントを含むページネーションありの応答を示しています。
{
失敗した応答 要求が失敗した場合、APIは次のいずれかのHTTPエラーコードを返します。
名前
HTTPSステータスコード
エラーメッセージ
未承認
401
無効なsessionIdです。
禁止されています
403
権限なし。
内部サーバーエラー
500
内部サーバーエラーのため失敗しました。