アクティビティログ
activityLogソースを使用して、タスクID、実行ID、またはその両方を使用して、完了したジョブの詳細を取得します。
REST APIバージョン1リソース
ファイル取り込みとレプリケーションタスクREST APIバージョン1リソースを使用して、タスクID、実行ID、またはその両方を使用して、完了したジョブの詳細を取得します。
GET要求
タスクIDを使用して完了したジョブの詳細を要求するには、次のURIを使用します。
mftsaas/api/v1/mitasks/activityLog?taskId=<taskId>
実行IDを使用してアクティブなジョブまたは完了したジョブの詳細を要求するには、次のURIを使用します。
mftsaas/api/v1/mitasks/activityLog?runId=<runId>
スキップする行数を指定するには、次のURIを使用します。
mftsaas/api/v1/mitasks/activityLog?taskId={{taskID}}&<offset>
行制限を指定するには、次のURIを使用します。
mftsaas/api/v1/mitasks/activityLog?taskId={{taskID}}&<rowLimit>
上記のオプションは組み合わせて使用することができます。例えば、次のようなURIを使用できます。
mftsaas/api/v1/mitasks/activityLog?runId=<runId>&taskId=<taskId>&rowLimit=<rowLimit>&offset=<offset>
activityLogのGET URIには、次の属性を使用できます。
フィールド | 説明 |
|---|
taskId | ファイル取り込みとレプリケーションタスクID。 |
runId | ファイル取り込みとレプリケーションの実行ID。 |
offset | スキップする行数。例えば、最初の3行をスキップする場合に使用します。 |
rowLimit | 返す最大行数。指定可能な最大数値は100です。デフォルトは25です。 |
注: GET URIでtaskIdまたはrunId属性のいずれかを指定する必要があります。
GET応答
activityLogオブジェクトは、次の属性を返します。
フィールド | 説明 |
|---|
id | ファイル取り込みとレプリケーションジョブID。 |
totaljobCount | ジョブの総数。 |
taskId | ファイル取り込みとレプリケーションタスクID。 |
runId | ファイル取り込みとレプリケーションの実行ID。 |
startedBy | ファイル取り込みとレプリケーションタスクを作成したユーザーの名前。 |
startTime | ジョブの開始時刻。協定世界時（UTC）を使用します。 |
endTime | ジョブの終了時刻。協定世界時（UTC）を使用します。 |
status | ジョブが正常に完了したかどうかを示します。 |
messageText | ジョブに関連付けられているエラーメッセージ。 |
successFiles | ソースからターゲットに正常に転送されたファイルの数。 |
failedFiles | ソースからターゲットに転送されなかったファイルの数。 |
GETの例
次の例は、タスクIDを使用してファイル取り込みとレプリケーションジョブの詳細を取得した応答を示しています。
{
"totalJobCount": 7,
"jobActivityLog": [
{
"id": 1000000200272,
"taskId": 89882,
"runId": 137205,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:55:13Z",
"endTime": "2021-09-13T09:55:15Z",
"status": "FAILED"
},
{
"id": 1000000200270,
"taskId": 89882,
"runId": 137204,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:52:44Z",
"endTime": "2021-09-13T09:53:02Z",
"status": "SUCCESS"
},
{
"id": 1000000200268,
"taskId": 89882,
"runId": 137202,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:49:55Z",
"endTime": "2021-09-13T09:50:12Z",
"status": "SUCCESS"
},
{
"id": 1000000200264,
"taskId": 89882,
"runId": 137199,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:43:27Z",
"endTime": "2021-09-13T09:43:42Z",
"status": "SUCCESS"
},
{
"id": 1000000200262,
"taskId": 89882,
"runId": 137198,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:13:58Z",
"endTime": "2021-09-13T09:14:04Z",
"status": "FAILED"
},
{
"id": 1000000200261,
"taskId": 89882,
"runId": 137197,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:13:09Z",
"endTime": "2021-09-13T09:13:28Z",
"status": "SUCCESS"
},
{
"id": 1000000200260,
"taskId": 89882,
"runId": 137196,
"startedBy": "b2b_pod1",
"startTime": "2021-09-13T09:12:21Z",
"endTime": "2021-09-13T09:12:35Z",
"status": "SUCCESS"
}
]
}
次の例は、実行IDを使用してファイル取り込みとレプリケーションジョブの詳細を取得した応答を示しています。
{
"jobActivityLog": [
{
"jobStatusResponse": {
"jobStatus": "FAILED",
"errorMessage": "[8008 - Create File List] Directory '/root/testnot' not found ",
"jobDetails": {
"jobNumber": 1000000200262,
"status": "Failed",
"startTime": "2021-09-13T09:13:58Z",
"endTime": "2021-09-13T09:14:04Z",
"messageText": "[8008 - Create File List] Directory '/root/testnot' not found ",
"successFiles": 0,
"failedFiles": 0,
"fileDetails": []
}
}
}
]
}
{
"jobActivityLog": [
{
"jobStatusResponse": {
"jobStatus": "FAILED",
"errorMessage": "[8008 - Create File List] Directory '/root/testnot' not found ",
"jobDetails": {
"jobNumber": 1000000200262,
"status": "Failed",
"startTime": "2021-09-13T09:13:58Z",
"endTime": "2021-09-13T09:14:04Z",
"messageText": "[8008 - Create File List] Directory '/root/testnot' not found ",
"successFiles": 0,
"failedFiles": 0,
"fileDetails": []
}
}
}
]
}
REST APIバージョン2リソース
ファイル取り込みとレプリケーションタスクREST APIバージョン2リソースを使用して、タスクID、実行ID、またはその両方を使用するか、どちらも使用せずに、特定のジョブタイプの詳細を取得します。
GET要求
ファイル取り込みとレプリケーションタスクのすべてのジョブの詳細を要求するには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog
タスクIDを使用してすべてのジョブの詳細を要求するには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>
実行IDを使用してすべてのジョブの詳細を要求するには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog?runId=<runId>
スキップする行数を指定するには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>&offset=<offset>
行制限を指定するには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>&rowLimit<rowLimit>
ジョブタイプを指定するには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog?jobType=<jobType>
表示するファイルイベントの数を指定し、ファイルイベントの制限を含めるには、次のURIを使用します。
mftsaas/api/v2/mitasks/activityLog?runId={{runID}}&fetchFileEvents=true&fileEventsLimit=10
上記のオプションは組み合わせて使用することができます。例えば、次のようなURIを使用できます。
mftsaas/api/v2/mitasks/activityLog?runId=<runId>&taskId=<taskId>&rowLimit=<rowLimit>&offset=<offset>
activityLogのGET URIには、次の属性を使用できます。
フィールド | 説明 |
|---|
taskId | ファイル取り込みとレプリケーションタスクID。 |
runId | ファイル取り込みとレプリケーションの実行ID。 |
offset | スキップする行数。例えば、最初の3行をスキップする場合に使用します。 |
rowLimit | 返す最大行数。指定可能な最大数値は100です。デフォルトは25です。 |
jobType | 応答に含めるジョブのタイプ。次のいずれかのオプションを使用できます。 デフォルトは［すべて］です。 |
fetchFileEvents | ファイルイベントを表示するかどうかを決定します。次のいずれかの値を設定します。 - - true。ファイル取り込みとレプリケーションタスクはジョブファイルイベントを表示します。
- - false。ファイル取り込みとレプリケーションタスクはジョブファイルイベントを表示しません。
デフォルトはfalseです。 |
fileEventsLimit | 返されるファイルイベントの数。fetchFileEventsがtrueに設定されている場合に適用されます。指定可能な最大数値は1000です。デフォルトは100です。 |
GET応答
activityLogオブジェクトは、次の属性を返します。
フィールド | 説明 |
|---|
totaljobCount | ジョブの総数。 |
taskId | ファイル取り込みとレプリケーションタスクID。 |
runId | ファイル取り込みとレプリケーションの実行ID。 |
startedBy | ファイル取り込みとレプリケーションタスクを作成したユーザーの名前。 |
startTime | ジョブの開始時刻。協定世界時（UTC）を使用します。 |
endTime | ジョブの終了時刻。協定世界時（UTC）を使用します。 |
status | ジョブが正常に完了したかどうかを示します。 |
logLocation | セッションログの場所。 |
messageText | ジョブのステータスに関連付けられたコメント。 |
successFiles | ソースからターゲットに正常に転送されたファイルの数。 |
failedFiles | ソースからターゲットに転送されなかったファイルの数。 |
GETの例
次の例は、タスクIDを使用してファイル取り込みとレプリケーションジョブの詳細を取得する要求への応答を示しています。
{
"totalJobCount": 1,
"jobActivityLog": [
{
"taskId": "gS7ivoMYoOli6v7TR7MIIe",
"jobs": [
{
"runId": 490176,
"startedBy": "b2b_pod1",
"startTime": "2023-05-08T00:20:14Z",
"endTime": "2023-05-08T00:20:19Z",
"status": "SUCCESS"
"logLocation": "data/taskLogs/2023-05-08/1000000916286.log"
"messageText": "Job completed",
"successFiles": 8,
"failedFiles": 0
}
}
]
}
次の例は、fetchFileEventsがtrueに設定されているファイル取り込みとレプリケーションジョブの詳細を取得する要求への応答を示しています。
{
"totalJobCount": 1,
"jobActivityLog": [
{
"taskId": "34owubT0kvFe18LdELjXop",
"jobs": [
{
"runId": 496420,
"startedBy": "atl",
"startTime": "2023-05-08T07:25:25Z",
"endTime": "2023-05-08T07:25:54Z",
"status": "SUCCESS",
"logLocation": "data/taskLogs/2023-05-08/1000000855619.log",
"messageText": "Job completed normally",
"successFiles": 1003,
"failedFiles": 0,
"fileDetails": [
{
"path": "/root/Arun/May/Target/File_5.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 1,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_12.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_2.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_8.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_10.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 1,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_14.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 1,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_16.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_18.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_6.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
},
{
"path": "/root/Arun/May/Target/File_13.txt",
"size": 12,
"lastModified": "2023-05-04T09:00:30Z",
"startTime": "2023-05-08T07:25:12Z",
"status": "SUCCESS",
"duration": 0,
"transferDirection": "UPLOAD"
}
]
}
]
}
]
}