REST API 主動(應用程式)
- Last Updated: October 16, 2024
- 4 minute read
- WhatsUp Gold
- Version 2024
REST API 主動監控工具元件可讓您在特定裝置上執行監控工具,透過評估監控工具為上線或離線來取得關於裝置、伺服器或應用程式狀態的資訊。
如要將 REST API 主動監控工具作為元件加入現有的應用程式:
- 選取 [設定] > [應用程式監控] > [應用程式與設定檔設定] 。
- 以 〈使用應用程式設定檔〉 中所描述的方法來新增一個應用程式設定檔。
- 以 〈元件、重要元件群組和獨立應用程式〉 中所描述的方法來新增一個元件。
- 在「應用程式設定檔編輯」對話方塊中,選取 [元件] 索引標籤,然後按一下新增圖示來新增一個元件。
- 對於元件名稱,請選取 [REST API] > [REST API 主動] 。
- 在「元件編輯工具」中,設定以下的欄位:
- 名稱 :輸入元件的專屬名稱。此名稱會顯示在「應用程式設定檔編輯工具」的「效能元件」頁面中。
- 說明 :輸入元件的其他資訊。
- 重要 :如果這是一個重要元件,請選取。
- 裝置覆寫 :如果您想要讓裝置可以覆寫此元件,請選取。
- 輪詢間隔時間 :選取檢查元件的間隔時間。
- 連線逾時 :選取要求多久之後才會逾時。
-
REST API
:為元件新增 REST API 端點的 URL。註: REST API URL 中支援系統 (%System)、裝置 (%Device) 和應用程式 (%Application) 的參考變數(又稱為百分比變數)。如需詳細資訊,請參閱 〈百分比變數〉 。不過若進行測試,此運算式將會評估為 False 。建議在將運算式參數化並將其附加至裝置之前,先確認 REST API 傳回有效的回應。
-
編輯自訂標頭
:輸入最多 10 個存取 REST API 端點所需的自訂標頭。系統提供一個預設的「Accept」標頭並將其指定為「
application/json
」。註: 如要監控 OpenEdge OEManager REST API 端點的 Progress 應用程式伺服器,「Accept」標頭必須設定為「 application/vnd.progress+json 」或「 */* 」。
- 方法 :為 REST API 端點選取一個支援的 HTTP 方法。目前僅支援 GET 方法。
- 忽略憑證錯誤 :啟用此核取方塊來強制 WhatsUp Gold 略過任何憑證錯誤。
- 使用匿名存取 :如果 REST API 端點不需要身分驗證,那麼請勾選此方塊。
-
JSONPATH
:輸入您要監控的 JSON 物件的路徑,或者使用 JSONPath 建置工具來確保您有導向所要監控的物件的正確路徑。 註: 如要深入了解 JSONPath 和 JSONPath 建置工具,請參閱 〈JSONPath 查詢〉和〈JSONPath 建置工具〉 。
- JSONPath 建置工具 :輸入一個有效的 REST API URL 端點之後,您可以使用 JSONPath 建置工具來檢視 JSON 回應的結構,然後選取您想要監控的 JSON 值。
- 離線條件 :若傳回任何所列出的 HTTP 回應碼,那麼監控工具將會回報為「離線」。您可以控制哪些回應碼表示監控工具為離線,還可以提供一個 JSONPath 査詢以及表示監控工具是否為離線的條件。監控工具可以使用一個離線條件、一個 JSONPath 查詢或者兩者皆使用來傳回一個離線回應。
- JSONPATH 查詢 :設計一個邏輯測試來評估 REST API 端點傳回的條件:
- 選取新增圖示來輸入一個使用 JSONPath 查詢的條件測試。預設將會在行內顯示「未設定比較」的文字。
- 在 JSONPath 查詢輸入內按兩下,然後選取放大鏡標誌。如果為沒有勾選「使用匿名存取」的話,那麼這將會提示您輸入一個 REST API 認證。 REST API 認證 通過驗證之後,將會開啟 JSONPath 建置工具視窗。
- 選取要監控的端點。
- 建置一個邏輯測試來表示所監控的 REST API 端點為離線的條件。支援的值類型為布林值、數字、字串和其他。若值為空 (Null),則將會勾選「其他」資料類型。支援空白字串。
- 按一下 [儲存] 。
- 選取 [測試] 來執行 REST API。
- 按一下 [確定] 來結束元件編輯工具。
若要將此元件加入到一部裝置上現有的應用程式設定檔中:
- 移至 [受監控的應用程式],然後選取「新增」圖示。
- 新增您所建立的應用程式設定檔,以及要將應用程式設定檔附加到的裝置。
- 根據需要設定其他欄位。
- 按一下 [儲存] 。
元件測試會在裝置上執行。