REST API(效能)
REST API 效能監控工具剖析 JSON 格式的 REST API 回應資料來擷取效能數據。來自 REST API 呼叫的 JSON 回應必須包含一個傳回裝置、伺服器或應用程式健全狀況數據的數值欄位。
設定以下欄位,以設定 REST API 效能監控工具:
- :輸入監控工具的專屬名稱。此名稱會顯示在「效能監控工具資料庫」中。
- :輸入監控工具的其他資訊。這段說明會顯示在「效能監控工具資料庫」中監控工具名稱的旁邊。
- :輸入 WhatsUp Gold 等候 REST API 回應的時間應該為多久,一旦超出就結束連線並傳回逾時錯誤訊息。最小值是 1 秒,最大值是 120 秒。
-
- 。輸入最多 10 個存取 REST API 端點所需的自訂標頭。
- 。您想要監控的 REST API 端點的 URL。
: REST API URL 中支援系統 (%System)、裝置 (%Device) 和應用程式 (%Application) 的參考變數(又稱為百分比變數)。如需詳細資訊,請參閱〈百分比變數〉。不過若以 按鈕進行測試,運算式將會評估為 。建議在將運算式參數化並將其附加至裝置之前,先確認 REST API 傳回有效的回應。
- :為 REST API 端點選取一個支援的 HTTP 方法。目前僅支援 GET 方法。
- :啟用此核取方塊來強制 WhatsUp Gold 略過任何憑證錯誤。
- :如果 REST API 端點不需要身分驗證,那麼請勾選此方塊。
- :輸入您要監控的 JSON 物件的路徑,或者使用 JSONPath 建置工具來確保您有導向所要監控的物件的正確路徑。JSONPath 必須參照到 REST API 呼叫回應中的一個數值欄位。
: 如要深入了解 JSONPath 和 JSONPath 建置工具,請參閱〈JSONPath 查詢〉和〈JSONPath 建置工具〉。
- :輸入一個有效的 REST API URL 端點之後,使用 JSONPath 建置工具來檢視 JSON 回應的結構,然後選取您想要監控的數值 JSON 值。
按一下 來確認您已為 REST API 效能監控工具輸入有效的組態。