システムログ取得

検索条件に一致するシステムログ一覧を取得します。

必要な権限

MASTER ロールが必要です。

HTTPリクエスト

GET /api/sonar/system-logs

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/system-logs?levels=ERROR&from=2024-06-18%2000:00:00+0900&to=2024-06-18%2023:59:59+0900&limit=50"

リクエストパラメータ

キー	必須	型	説明	備考
offset	X	64ビット整数	スキップする件数	デフォルト: 0
limit	X	64ビット整数	最大件数
keywords	X	文字列リスト	検索キーワード	複数のキーワードを指定可能
nodes	X	文字列リスト	ノード別にフィルタリングするノード GUID の一覧
levels	X	文字列リスト	ログレベルフィルタ	`INFO`, `WARN`, `ERROR`, `FATAL` のいずれか
from	X	日付	取得開始時刻	形式: `yyyy-MM-dd HH:mm:ssZ`
to	X	日付	取得終了時刻	形式: `yyyy-MM-dd HH:mm:ssZ`

正常応答

{
  "system_logs": [
    {
      "created_at": 1718668800000,
      "node_guid": "a1b2c3d4-1111-2222-3333-444455556666",
      "node_name": "control-01",
      "node_pair_guid": null,
      "node_pair_name": null,
      "module": "logstorage",
      "code": 1001,
      "level": "ERROR",
      "params": {},
      "msg": "failed to flush table buffer"
    }
  ],
  "total": 1,
  "levels": ["INFO", "WARN", "ERROR"]
}

system_logs (配列): 検索条件に一致するシステムログ項目の一覧
- created_at (日付): 作成時刻 (エポックミリ秒)
- node_guid (文字列, オプション): ノード GUID
- node_name (文字列): ノード名
- node_pair_guid (文字列, オプション): ペアノード GUID
- node_pair_name (文字列, オプション): ペアノード名
- module (文字列): モジュール名
- code (32ビット整数): ログコード
- level (文字列): ログレベル
- params (マップ): メッセージパラメータ
- msg (文字列): ログメッセージ
total (64ビット整数): 検索条件に一致する全件数
levels (配列): フィルタ構成に使用できるログレベルラベルの一覧 (ローカライズされた文字列)

エラー応答

from, to の値の日付形式が不正な場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-argument",
  "error_msg": "invalid date format"
}

levels の値が有効なログレベルでない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-argument",
  "error_msg": "No enum constant com.logpresso.sonar.api.systemlog.SystemLogLevel.DEBUG"
}

offset, limit の値が整数でない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be long type"
}

権限がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}