JobLog API

概要

JobLog APIは、Fess のジョブ実行ログを参照・管理するためのAPIです。 スケジュールジョブやクロールジョブの実行履歴、実行結果、エラー情報などを取得・削除できます。

ベースURL

/api/admin/joblog

エンドポイント一覧

メソッド パス 説明
GET /logs ジョブログ一覧取得
GET /log/{id} ジョブログ取得
DELETE /log/{id} ジョブログ削除

ジョブログ一覧取得

リクエスト

GET /api/admin/joblog/logs

パラメーター

パラメーター 型 必須 説明
size Integer いいえ 1ページあたりの件数（デフォルト: 25。fess_config.properties の paging.page.size で変更可能）
page Integer いいえ ページ番号（1から開始、デフォルト: 1）
id String いいえ ジョブログIDによる絞り込み（完全一致）

これらのパラメーターは、JSON のリクエストボディ（例: {"size": 50, "page": 1} ）で指定します。URL のクエリ文字列（例: ?size=50 ）で指定した値は無視されるため、指定しない場合は常に先頭の 25 件が返ります。

レスポンス

{
  "response": {
    "status": 0,
    "logs": [
      {
        "id": "joblog_id_1",
        "job_name": "Default Crawler",
        "job_status": "ok",
        "target": "all",
        "script_type": "javascript",
        "script_data": "return container.getComponent(\"crawlJob\").execute();",
        "script_result": "Job completed successfully",
        "start_time": "1738116000000",
        "end_time": "1738118723000"
      },
      {
        "id": "joblog_id_2",
        "job_name": "Default Crawler",
        "job_status": "fail",
        "target": "all",
        "script_type": "javascript",
        "script_data": "return container.getComponent(\"crawlJob\").execute();",
        "script_result": "Error: Connection timeout",
        "start_time": "1738029600000",
        "end_time": "1738030215000"
      }
    ],
    "total": 100
  }
}

レスポンスフィールド

フィールド 説明
id ジョブログID
job_name ジョブ名
job_status ジョブステータス（ok: 成功、fail: 失敗、running: 実行中）
target 実行対象（スケジューラーのターゲット名。既定値は all）
script_type スクリプトタイプ（例: javascript）
script_data 実行スクリプト
script_result 実行結果
start_time 開始時刻（エポックミリ秒。文字列として返されます）
end_time 終了時刻（エポックミリ秒。文字列として返されます）。実行中のジョブでは返されません。

注釈

レスポンスの各ログオブジェクトには、内部的に使用される crud_mode フィールド （CRUD操作モードを示す整数値で、参照時は常に 0）が含まれます。 クライアント側では無視して問題ありません。

ジョブログ取得

リクエスト

GET /api/admin/joblog/log/{id}

レスポンス

{
  "response": {
    "status": 0,
    "log": {
      "id": "joblog_id_1",
      "job_name": "Default Crawler",
      "job_status": "ok",
      "target": "all",
      "script_type": "javascript",
      "script_data": "return container.getComponent(\"crawlJob\").execute();",
      "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0",
      "start_time": "1738116000000",
      "end_time": "1738118723000"
    }
  }
}

指定したIDのジョブログが存在しない場合は、status に 0 以外の値が設定された エラーレスポンスが返されます。

ジョブログ削除

リクエスト

DELETE /api/admin/joblog/log/{id}

レスポンス

{
  "response": {
    "status": 0
  }
}

指定したIDのジョブログが存在しない場合は、status に 0 以外の値が設定された エラーレスポンスが返されます。

使用例

ジョブログ一覧の取得

curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"size": 50, "page": 1}'

失敗したジョブのみ抽出

# jqで失敗したジョブをフィルター
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"size": 1000}' | \
     jq '.response.logs[] | select(.job_status=="fail")'

ジョブログの取得

curl -X GET "http://localhost:8080/api/admin/joblog/log/joblog_id_1" \
     -H "Authorization: Bearer YOUR_TOKEN"

ジョブログの削除

curl -X DELETE "http://localhost:8080/api/admin/joblog/log/joblog_id_1" \
     -H "Authorization: Bearer YOUR_TOKEN"

ジョブ成功率の計算

curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"size": 1000}' | \
     jq '.response.logs | {total: length, ok: [.[] | select(.job_status=="ok")] | length, fail: [.[] | select(.job_status=="fail")] | length}'

参考情報