テーブル一覧取得

検索条件に一致するログプレッソ・ソナーのテーブル一覧を取得します。本操作には管理者権限が必要です。

Tip

同一インスタンスであっても、ログプレッソ・エンタープライズで作成されたテーブルはログプレッソ・ソナーに構成情報が存在しないため、表示されません。

必要な権限

MEMBER以上のロールが必要です。

HTTPリクエスト

GET /api/sonar/tables

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/tables

リクエストパラメータ

キー	必須	型	説明	備考
offset	X	32ビット整数	スキップする件数	デフォルト: 0
limit	X	32ビット整数	最大件数	デフォルト: 2147483647
keywords	X	文字列	検索キーワード	table_nameを対象に検索
schema_code	X	文字列	スキーマコード	指定したスキーマを利用しているテーブル一覧取得
table_name	X	文字列	テーブル名	特定テーブル名でフィルタリング
group_guid	X	文字列	グループGUID	特定テーブルグループに属するテーブル一覧取得

正常応答

{
  "total_count": 1,
  "tables": [
    {
      "table_name": "evtx_system",
      "layout": "columnar",
      "compression": "snappy",
      "retention": 180,
      "crypto_profile_guid": "b2c3d4e5-f6g7-8901-bcde-f23456789012",
      "crypto_profile_name": "Default Crypto Profile",
      "encrypted": true,
      "min_day": "2021-10-19 00:00:00+0900",
      "max_day": "2022-09-14 00:00:00+0900",
      "table_size": 7195337,
      "index_size": 0,
      "ratio": 0.75,
      "group_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "group_name": "Windows Events"
    }
  ]
}

total_count (32ビット整数): 検索結果に一致する全件数
tables (配列): テーブル一覧
- table_name (文字列): テーブル名
- layout (文字列): ブロックレイアウト（row または columnar）、デフォルト: columnar
- compression (文字列): 圧縮アルゴリズム（deflate または snappy）、デフォルト: snappy
- retention (32ビット整数): データ保持期間（日単位）、デフォルト: 0（無制限）
- crypto_profile_guid (文字列, encryptedがtrueの場合): 暗号化プロファイルGUID
- crypto_profile_name (文字列, encryptedがtrueの場合): 暗号化プロファイル名
- encrypted (ブール値, オプション): 暗号化利用有無
- min_day (文字列, オプション): 保存されている最小ログ日付（_timeフィールド基準）
- max_day (文字列, オプション): 保存されている最大ログ日付（_timeフィールド基準）
- table_size (64ビット整数): テーブルデータサイズ（バイト単位）
- index_size (64ビット整数): インデックスデータサイズ（バイト単位）
- ratio (64ビット実数): 全テーブルに対するディスク使用量の割合（0～1）
- group_guid (文字列, オプション): テーブルグループGUID
- group_name (文字列, オプション): テーブルグループ名

Note

テーブル一覧取得APIでは、セキュリティ上の理由からshared_users、shared_groups、node_statsフィールドは除外されます。これらの情報が必要な場合はテーブル取得APIをご利用ください。

エラー応答

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

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

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

offset, limitの値が負の場合

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

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}

offset, limitの値が最大値を超える場合

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

{
  "error_code": "invalid-argument",
  "error_msg": "'limit' must be less than or equal to 2147483647."
}

group_guidの値がGUID形式でない場合

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

{
  "error_code": "invalid-param-type",
  "error_msg": "group_guid should be guid type."
}

権限がない場合

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

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