activityLog
ジョブリソースを使用して、タスク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を使用できます。
/api/v1/activity/activityLog?offset=<offset>&rowLimit=<rowLimit>&taskId=<taskId>&runId=<runId>
activityLogのGET URIには、次の属性を使用できます。
フィールド | 説明 |
|---|
id | ファイル取り込みジョブのID。 |
taskId | ファイル取り込みタスクのID。 |
runId | ファイル取り込み実行のID。 |
offset | スキップする行数。例えば、最初の3行をスキップする場合に使用します。 |
rowLimit | 返す最大行数。指定可能な最大数値は100です。デフォルトは25です。 |
GET応答
activityLogオブジェクトは、次の属性を返します。
フィールド | 説明 |
|---|
id | ファイル取り込みジョブのID。 |
totaljobCount | ジョブの総数。 |
taskId | ファイル取り込みタスクのID。 |
runId | ファイル取り込み実行のID。 |
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": []
}
}
}
]
}