2分鐘閱讀

監控數據查詢 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，可以在不丟失查詢參數的情況下安全地獲取統計數據。

疑難排解

症狀	原因	解決
認證失敗 (RstVal 不為 0)	缺少或誤填 `x-giip-ak` 或 `x-giip-sk` 請求頭	使用有效的金鑰值包含兩個請求頭後重試
響應數據為空	請求體中的 `serverIsn` 值錯誤或非數字	指定目標伺服器正確的數字 `serverIsn`
效能歷史查詢無結果	`startTime`/`endTime` 不是 ISO 8601（如 `2026-03-19T00:00:00Z`）格式或時間段顛倒	確認正確的時間格式和 `startTime < endTime`，並指定 `interval`（如 `5m`）
大批量查詢時數據被截斷	透過普通端點發送大量 `jsondata`	切換到 `giipApiSk3` 端點以防止數據丟失

版本: 1.1 最後更新: 2026-04-11 源碼: giipv3/public/help/api-monitoring.zh-TW.md

相關文檔:

API 結果代碼指南 (RstVal)