ジョブ
jobリソースを使用して、ファイル取り込みとレプリケーションジョブを開始します。また、jobリソースを使用して、ファイル取り込みとレプリケーションタスクのジョブステータスやジョブのログを取得することもできます。ファイル取り込みとレプリケーションREST APIバージョン1のtaskリソースを使用して、タスクのIDと名前を取得します。
RUN要求
ファイル取り込みとレプリケーションタスクジョブを開始するには、次のURIを使用します。
mftsaas/api/v1/job
要求に次の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
|---|
taskId | String | ○ | ファイル取り込みとレプリケーションのID。 |
taskName | String | - | ファイル取り込みとレプリケーションの名前。 |
ファイル取り込みとレプリケーションジョブを開始するときは、指定したコネクタに対して次のソースディレクトリキーとターゲットディレクトリキーを使用します。
コネクタ | srcDir | tgtDir |
|---|
ローカル | sourceDirectory | targetDirectory |
ftp,ftps,sftp | sourceDirectory | targetDirectory |
gcs | sourceDirectory | gcsTargetLocation |
hdfs | sourceDirectory | hdfsTargetLocation |
adlsgen2 | sourceDirectory | adlsGen2TargetLocation |
s3 | s3SourceLocation | s3TargetLocation |
blob | blobSourceLocation | blobContainer |
ジョブリソースREST APIを使用して、次のようなパラメータを上書きできます。
カテゴリ | パラメータ | ID |
|---|
全般 | ソース接続 | sourceConnection |
全般 | ターゲット接続 | targetConnection |
全般 | 並列バッチログレベル | parallelBatch |
全般 | ログレベル | logLevel |
ソース | ソースディレクトリ | sourceDirectory |
ソース | ファイルパターン | filePattern |
ソース | バッチサイズ | batchSize |
ソース | サブフォルダのファイルを含む | includeSubfolder |
ソース | 重複するファイルをスキップ | checkDuplicate |
ソース | ファイルの安定性を確認 | fileStability |
ソース | 安定性確認間隔 | stabilityCheckInterval |
ターゲット | ターゲットディレクトリ | targetDirectory |
注: ソース接続パラメータとターゲット接続パラメータを上書きするには、接続IDを渡す必要があります。
次のサンプルを参照として使用して、ファイル取り込みとレプリケーションタスクジョブを開始します。
{
"taskId": "k1YHA1blhcBjbJvCIRQX2s",
"taskName": "localtolocal_param2"
}
次のサンプルを使用して、ユーザーインタフェースに渡されたソースオプション値を上書きします。
"variables": [{
"variable": "<string>",
"value": "<string>"
}]
次の例では、ジョブリソースREST APIの使用中に、ユーザーインタフェースで渡されたパラメータ値が、JSON POSTで指定された対応する値で上書きされます。
POST <serverUrl>/mftsaas/api/v1/job HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>
{
"taskId": "0efdVUEZeV2cB0quomeksd",
"taskName": "localtolocal_param2",
"parameters": {
"category": [{
"id": "General",
"parameter": [
{
"id":"sourceConnection",
"value":"AdvancedSFTPV2"
},
{
"id":"targetConnection",
"value":"AdvancedSFTPV2"
},
{
"id":"parallelBatch",
"value":"10"
},
{
"id":"logLevel",
"value":"DEBUG"
}
]
},{
"id": "Source",
"parameter": [{
"id": "sourceDirectory",
"value": "/root/test1"
},
{
"id":"filePatternType",
"value":"reg"
},
{
"id": "filePattern",
"value": "*.txt"
},
{
"id": "batchSize",
"value": "5"
},
{
"id":"includeSubfolder",
"value":"true"
},
{
"id":"checkDuplicate",
"value":"true"
},
{
"id":"fileStability",
"value":"true"
},
{
"id":"stabilityCheckInterval",
"value":"30"
}
]
},
{
"id": "Target",
"parameter": [{
"id": "targetDirectory",
"value": "/root/test2"
}]
}
]
}
}
次の例は、filenameを変数としてファイル取り込みとレプリケーションタスクを上書きする方法を示しています。
POST <serverUrl>/mftsaas/api/v1/job HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>
{
"taskId": "4m24k3UFWMkkqd55YDefIB",
"taskName": "R41_Local_Local",
"parameters": {
"category": [
{
"id": "Source",
"parameter": [
{
"id": "sourceDirectory",
"value": "/${Parentfolder}"
},
{
"id": "filePickupFilePath",
"value": "${filename}"
},
{
"id": "batchSize",
"value": "5"
}
]
},
{
"id": "Target",
"parameter": [
{
"id": "targetDirectory",
"value": "/${Parentfolder}/Target"
}
]
}
]
},
"variables": [
{
"variable": "Parentfolder",
"value": "root/Arun"
},
{
"variable": "filename",
"value": "filepath.txt"
}
]
}
次の例は、filelistを変数としてファイル取り込みとレプリケーションタスクを上書きする方法を示しています。
POST <serverUrl>/mftsaas/api/v1/job HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>
{
"taskId": "4m24k3UFWMkkqd55YDefIB",
"taskName": "R41_Local_Local",
"parameters": {
"category": [
{
"id": "Source",
"parameter": [
{
"id": "sourceDirectory",
"value": "/${Parentfolder}"
},
{
"id": "filePickupFileList",
"value": "${filelist}"
},
{
"id": "batchSize",
"value": "5"
}
]
},
{
"id": "Target",
"parameter": [
{
"id": "targetDirectory",
"value": "/${Parentfolder}/Target"
}
]
}
]
},
"variables": [
{
"variable": "Parentfolder",
"value": "root/Arun"
},
{
"variable": "filelist",
"value": "File1.txt,File2.txt,File3.txt,File4.txt"
}
]
}
RUN応答
成功すると、ファイル取り込みとレプリケーションはジョブの実行IDを返します。実行IDを使用して、ジョブのステータスを監視したり、ジョブのログファイルを要求したりします。
失敗すると、応答にエラーの理由が含まれます。
GETステータス要求
特定のファイル取り込みとレプリケーションタスクジョブのステータスを取得するには、次のURIを使用します。
mftsaas/api/v1/job/<runId>/status
GETステータス応答
成功すると、ファイル取り込みとレプリケーションはジョブのステータスと詳細を返します。これにはファイルのリストと、各ファイルの詳細およびステータスが含まれます。
失敗すると、応答にエラーの理由が含まれます。
GETジョブのログ要求
特定のファイル取り込みとレプリケーションタスクジョブのログファイルを取得するには、次のURIを使用します。
mftsaas/api/v1/job/<runId>/logs
GETジョブのログ応答
成功すると、ファイル取り込みとレプリケーションはジョブのログファイルを返します。
失敗すると、応答にエラーの理由が含まれます。