REST API (パフォーマンス)
- Last Updated: October 16, 2024
- 3 minute read
- WhatsUp Gold
- Version 2024
REST API パフォーマンスモニタは、JSON 形式の REST API 応答データを解析して、パフォーマンス指標を抽出します。REST API コールの JSON 応答には、デバイス、サーバー、またはアプリケーションの正常性指標を返す数値フィールドが含まれている必要があります。
REST API パフォーマンスモニタをセットアップするには、以下のフィールドを設定します。
- [名前] 。モニタの固有の名前を入力します。この名前がパフォーマンスモニタライブラリに表示されます。
- [説明] 。モニタに関する追加情報を入力します。この説明は、パフォーマンスモニタライブラリでモニタ名の横に表示されます。
- [タイムアウト] 。接続を終了し、タイムアウトエラーを返す前に、REST API の応答を WhatsUp Gold が待機する時間を入力します。最小許容値は 1 秒、最大許容値は 120 秒です。
-
REST API
- [カスタムヘッダーの編集] 。REST API エンドポイントにアクセスするために必要な最大 10 個のカスタムヘッダーを入力します。
-
[REST API URL]
。監視する REST API エンドポイントの URL。注: システム (%System)、デバイス (%Device)、およびアプリケーション (%Application) の参照変数 ( パーセント変数 とも呼ばれます) が、REST API URL でサポートされています。詳細については、「パーセント変数」を参照してください。ただし、 [確認] ボタンでテストした場合、式は false になります。式をパラメータ化してデバイスに関連付ける前に、REST API が有効な応答を返すことを確認することをお勧めします。
- [メソッド] 。REST API エンドポイントでサポートされている HTTP メソッドを選択します。現在サポートされているのは GET メソッドのみです。
- [認証エラーを無視する] 。WhatsUp Gold で強制的に認証エラーを無視する場合は、このチェックボックスを有効にします。
- [匿名アクセスを使用する] 。REST API エンドポイントが認証を必要としない場合は、このボックスをオンにします。
-
[JSONPATH]
。監視する JSON オブジェクトへのパスを入力するか、JSONPath Builder を使用して、監視するオブジェクトへのパスが正しいことを確認します。JSONPath は、REST API コールの応答の数値フィールドを参照する必要があります。注: JSONPath と JSONPath Builder の詳細については、「 JSONPath クエリおよび JSONPath Builder 」を参照してください。
- [JSONPath Builder] 。有効な REST API URL エンドポイントを入力したら、JSONPath Builder を使用して JSON 応答の構造を表示し、監視する JSON の数値を選択します。
[確認] をクリックして、REST API パフォーマンスモニタに対して有効な設定を入力したことを確認します。