REST API (アクティブ)

REST API アクティブモニタを使用すると、匿名認証と基本認証をサポートする REST API を監視することができます。また、JSONPath クエリを使用して JSON 応答を検証することができます。

REST API アクティブモニタを設定するには:

[名前]。モニタの固有の名前を入力します。この名前がアクティブモニタライブラリに表示されます。
[説明]。モニタに関する追加情報を入力します。この説明は、アクティブモニタライブラリでモニタ名の横に表示されます。
[再スキャンで使用]。このオプションは、適用する理由となる新たな条件が検出された場合に、このアクティブモニタを適用するように WhatsUp Gold に指示します。
[タイムアウト]。接続を終了し、タイムアウトエラーを返す前に、REST API の応答を WhatsUp Gold が待機する時間を入力します。最小許容値は 1 秒、最大許容値は 120 秒です。
REST API
- [カスタムヘッダーの編集]。REST API エンドポイントにアクセスするために必要な最大 10 個のカスタムヘッダーを入力します。デフォルトの Accept ヘッダーが表示され、application/json として指定されます。
Note: Progress Application Server for OpenEdge OEManager REST API エンドポイントを監視するには、Accept ヘッダーを application/vnd.progress+json または */* に設定する必要があります。
- [REST API URL]。監視する REST API エンドポイントの URL。
Note:システム (%System)、デバイス (%Device)、およびアプリケーション (%Application) の参照変数 (パーセント変数とも呼ばれます) が、REST API URL でサポートされています。詳細については、「パーセント変数」を参照してください。
- [メソッド]。REST API エンドポイントでサポートされている HTTP メソッドを選択します。現在サポートされているのは GET メソッドのみです。
- [認証エラーを無視する]。WhatsUp Gold で強制的に認証エラーを無視する場合は、このチェックボックスを有効にします。
- [匿名アクセスを使用する]。REST API エンドポイントが認証を必要としない場合は、このボックスをオンにします。
[停止条件]。リストされている HTTP 応答コードのいずれかが返された場合に、モニタは停止中と報告されます。モニタが停止していることを示す応答コードを制御できます。また、モニタが停止しているかどうかを示す条件とともに JSONPath クエリを指定することもできます。モニタは、停止条件、JSONPath クエリ、またはその両方を使用して、停止応答を返すことができます。
[JSONPATH クエリ]。REST API エンドポイントが返す条件を評価するための論理テストを作成します。
1. [追加] アイコンを選択して、JSONPath クエリを使用した条件テストを入力します。デフォルトでは、「比較が設定されていません」というテキストがインラインで表示されます。
2. JSONPath クエリエントリ内をダブルクリックして、虫眼鏡のロゴを選択します。これにより、[匿名アクセスを使用する] がオフになっている場合は REST API 認証情報を入力するよう求めるプロンプトが表示されます。REST API 認証情報が確認されると、JSONPath Builder ウィンドウが開きます。
3. 監視するエンドポイントを選択します。
4. REST API エンドポイントを監視するための停止条件を表す論理テストを作成します。サポートされている値の種類は、ブール値、数値、文字列、および「その他」です。「その他」のデータの種類は、値が null かどうかを確認します。空の文字列はサポートされています。
5. [保存] をクリックします。

Note: JSONPath と JSONPath Builder の詳細については、「JSONPath クエリおよび JSONPath Builder」を参照してください。