セントリ一覧取得

検索条件に一致するセントリエージェントの一覧を取得します。

必要な権限

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

HTTPリクエスト

cURL例

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

リクエストパラメータ

正常応答

{
  "total_count": 1,
  "sentries": [
    {
      "node_pair_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "node_pair_name": "primary",
      "node_type": "DATA",
      "node_guid": "b2c3d4e5-f678-9012-bcde-f12345678901",
      "node_name": "data-node-1",
      "guid": "c3d4e5f6-7890-1234-cdef-123456789012",
      "alias": "sentry-host-01",
      "description": "Linux production sentry",
      "pkg_ver": "5.0.2509.0",
      "connected": true,
      "host_name": "host-01",
      "remote_ip": "192.0.2.10",
      "os": "Linux",
      "arch": "amd64",
      "os_ver": "Ubuntu 22.04",
      "java": "OpenJDK",
      "java_ver": "17.0.8",
      "working_dir": "/opt/sentry",
      "cpu": 12.5,
      "mem": 45.3,
      "disk": 32.0,
      "nic_tx": 1.2,
      "nic_rx": 0.8,
      "disk_usages": [],
      "nic_usages": []
    }
  ]
}

• total_count (32ビット整数): 検索条件に一致するセントリの総数
• sentries (配列): セントリ一覧
  • node_pair_guid (文字列): セントリが接続されているノードペアのGUID
  • node_pair_name (文字列): ノードペア名
  • node_type (文字列): ノードタイプ (CONTROL、DATA、FORWARDER など)
  • node_guid (文字列): 接続されているノードのGUID
  • node_name (文字列): ノード名
  • guid (文字列): セントリGUID (36文字)
  • alias (文字列): セントリエイリアス
  • description (文字列): セントリの説明
  • pkg_ver (文字列): セントリパッケージバージョン
  • connected (ブーリアン): 接続状態 (true: 接続中、false: 切断)
  • host_name (文字列): ホスト名
  • remote_ip (文字列): リモートIPアドレス
  • os (文字列): オペレーティングシステム名
  • arch (文字列): CPUアーキテクチャ
  • os_ver (文字列): オペレーティングシステムのバージョン
  • java (文字列): Javaランタイム名
  • java_ver (文字列): Javaバージョン
  • working_dir (文字列): セントリ実行ディレクトリ
  • cpu (64ビット浮動小数点): CPU使用率 (%)
  • mem (64ビット浮動小数点): メモリ使用率 (%)
  • disk (64ビット浮動小数点): ディスク使用率 (%)
  • nic_tx (64ビット浮動小数点): NIC送信使用率 (%)
  • nic_rx (64ビット浮動小数点): NIC受信使用率 (%)
  • disk_usages (配列): ディスクごとの使用量詳細
  • nic_usages (配列): NICごとの使用量詳細

エラー応答

offset、limit値が整数でない場合

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

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

権限がない場合

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

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