giip

モニタリングデータ照会 API リファレンス

サーバーおよびデータベースのリアルタイムパフォーマンスメトリクスと監査ログをプログラムから抽出する API を案内します。

🔌 サービスモニタリングページへ →

📋 概要

この API モジュールは、GIIPエージェントが収集した膨大なパフォーマンスデータを外部システム(Grafana、ELKなど)へ連動させたり分析したりするためのインターフェースを提供します。

🔐 認証およびヘッダー

すべてのリクエストは、共通の認証ヘッダーを含める必要があります。

  • Header:
    x-giip-ak: [Your Access Key]
  • Header:
    x-giip-sk: [Your Secret Key]

🚀 主要な API エンドポイント

1. リアルタイムサーバーメトリクスの照会 (Get Real-time Metrics)

  • URL:
    POST /api/monitoring/server/current
  • 説明: 特定のサーバーの最新のパフォーマンス状態(CPU、メモリ、ディスク)を照会します。
  • Request Body:
{
  "serverIsn": 456
}

2. パフォーマンス履歴の照会 (Get Metric History)

  • URL:
    POST /api/monitoring/server/history
  • 説明: 特定の期間におけるパフォーマンスの変化推移データを時系列で返します。
  • Request Body:
{
  "serverIsn": 456,
  "startTime": "2026-03-19T00:00:00Z",
  "endTime": "2026-03-19T23:59:59Z",
  "interval": "5m"
}

3. プロセス一覧照会 (Get Process List)

  • URL:
    POST /api/monitoring/server/processes
  • 説明: サーバーで現在実行中の全プロセスリストとリソース占有率を照会します。
  • Request Body:
{
  "serverIsn": 456
}

🔍 レスポンスデータの例 (Metrics)

{
  "RstVal": 0,
  "RstMsg": "Success",
  "Data": {
    "cpuUsage": 12.5,
    "memUsage": 45.2,
    "diskUsage": 68.1,
    "networkIn": 1024,
    "networkOut": 512
  }
}

💡 活用事例

  • カスタムダッシュボード: 社内統合監視ダッシュボードに GIIP のリアルタイムデータを埋め込みます。
  • 異常兆候の分析: パフォーマンス履歴 API でデータを抽出し、機械学習モデルに入力して障害を予測します。

🛡️ Sk3(高性能ロギング)の活用

高頻度のモニタリングデータ収集や大量の時系列パフォーマンス指標の照会において、データ転送の整合性と精巧なエラー追跡のために

giipApiSk3
エンドポイントを推奨します。

  • エンドポイント:
    https://giipfaw.azurewebsites.net/api/giipApiSk3
  • 利点: 大量のメトリクスデータを
    jsondata
    で送信する際に発生しうるデータ欠落を防止し、エラー時にエージェント側の詳細なログを自動収集することで、データ収集パイプラインの信頼性を保証します。
  • 活用チップ:
    startTime
    endTime
    interval
    などの複雑な照会条件を
    jsondata
    に含めてSk3を呼び出すことで、クエリパラメータの紛失を避け、安全に統計データを確保できます。

バージョン: 1.1 最終更新日: 2026-04-11 ソースファイル:

giipv3/public/help/api-monitoring.ja.md


関連ドキュメント: