REST API アクティブ (アプリケーション)

REST API アクティブモニタコンポーネントを使用すると、特定のデバイスでモニタを実行し、モニタが稼働しているかどうかを評価することで、デバイス、サーバー、またはアプリケーションのステータスに関する情報を取得することができます。

REST API アクティブモニタをコンポーネントとして既存のアプリケーションに追加するには:

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

このコンポーネントをデバイス上の既存のアプリケーションプロファイルに追加するには:

[監視対象アプリケーション] に移動し、[追加] アイコンを選択します。
作成したアプリケーションプロファイルと、アプリケーションプロファイルを添付するデバイスを追加します。
必要に応じて他のフィールドを設定します。
[保存] をクリックします。

コンポーネントテストがデバイスで実行されます。