REST API監視

REST API――概要

REST（REpresentational State Transfer）は、HTTPでのデータ通信方法を定義する管理ステータス情報のデザイン コンセプトです。RESTの定義に準拠したAPI呼び出しがREST APIであり、これは事実上、Web APIのほとんどを占めています。

REST API監視――当社が提供すること

  • REST APIエンド ポイントの可用性と応答時間を監視します。
  • お客さまAPIを利用するモバイルやWebのアプリケーションの応答時間を把握可能とします。
  • APIから正しい情報が返っているか、レスポンス詳細タブで確認できます。
  • APIトランザクションに失敗すれば、通知します。
  • ダウンを検知し、エンドの訪問者が影響を受ける前の予兆のうちに、問題を解決可能とします。

REST API監視――新規REST API監視の追加

REST APIで新規REST API監視を追加するには：こちらをクリックしてください。

GUIでREST API監視を設定するには、次の手順に従ってください。

  1. 新規監視をクリックし、REST APIを選択してください。
  2. 監視の表示名を入力します。
  3. 監視するAPI呼び出し、すなわち、REST API URLを入力してください。
  4. タイムアウトを指定します（秒）。Applications ManagerはAPIサービスをホストしているサーバーとの接続確立に、この時間まで待機します。
  5. APIアクセス時のフォーム送信メソッドを選択します。
  6. 必要に応じて、ユーザー名やパスワードなど認証情報を入力するか、認証情報マネージャーのリストから選択してください。認証不要の場合は空欄にしてください。
  7. APIサーバーへの接続確立に必要なHTTPヘッダーを指定します。ヘッダー名と値は「#」で区切ってください。複数ヘッダーは「_sep_」で区切ります。例：User-Agent#Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.172 Safari/537.36 Vivaldi/2.5.1525.48_sep_Accept-Charset#utf-8.
  8. 期待するレスポンスのタイプを指定します。XMLとJSONの場合、監視に固有のレスポンス値を定義し、監視の詳細ページのレスポンス詳細タブで確認できます。
  9. ブラウザーのプロキシ設定とApplications Managerのプロキシ設定は一致していなくてはなりません。監視するAPIによっては、ローカル アドレスとサブネット マスクの迂回が必要となります。
  10. ここでは、マッチを試みるコンテンツがAPIレスポンスに含まれるようにしてください。
  11. 認証情報のテストをクリックすると、APIサービスがApplications Managerインストール先からアクセス可能か確認できます。
  12. REST API監視を関連付ける監視グループを、コンボ ボックスで選択します（任意項目）。複数グループを選んで監視に関連付けることもできます。
  13. 監視の追加をクリックすると、REST APIサービスをネットワークから検出し監視が始まります。

監視パラメーター

監視タブをクリックして監視のカテゴリ ビューへ移動します。REST APIをWebサーバー/サービス テーブルで選択すると、バルク設定ビューが3つのタブに分類のうえ表示されます。

  • 可用性タブでは、過去24時間か30日の可用性履歴がわかります。
  • パフォーマンス タブでは、過去24時間か30日のステータスとイベントがわかります。
  • リスト ビューでは、バルク管理設定が可能です。
パラメーター 説明
応答時間 REST APIレスポンスを取得するまでの総時間を指します。REST API監視の応答時間は、DNS参照時間、接続時間、JSON/XML/テキストでレスポンスを受信するのにかかる時間の合計です。
  • 応答時間
  • ドメイン名解決時間
  • 接続時間
  • リクエスト処理時間
  • ダウンロード時間
レスポンス コンテンツ詳細 レスポンスのサイズ（バイト）と、連続ポーリング間のサイズの変化率（％）を示します。
  • ページ サイズ
  • ページ サイズの変化

カスタム属性

取得するレスポンスに応じ、ユーザーはAPIレスポンスで固有値を監視するため独自属性を定義できます。

  • レスポンスがXMLの場合：XSLT変換を利用し、監視する特定値を定義できます。MDN Web Docs（Mozilla Developer Network）やw3schools.comに詳細説明があります。次の基準に合っていることを確認ください。
    • 出力形式は「text」としてください。構文：<xsl:output method="text"/>
    • 最終出力は、AttrName::AttrVal形式の必要があります。サンプル：Days:<xsl:value-of select="days"/>では「Name」属性が作成され、その値はAPIレスポンスにある<days>タグのものとなります。
  • レスポンスがJSONの場合：ユーザー定義属性の設定には、JSONスキームを利用できます。次の基準に合っていることを確認ください。
    • 属性は、AttrName::AttrValueと定義してください。サンプル：Temperature::response.weather.temperatureでは、属性名「Temperature」が作成され、ここには気温の変数が返されることになります。
    • 複数のJSONスキームを定義するには、改行を区切り記号にする必要があります。
    • JSONキー自体でドット（.）が利用されている場合、「_sep_」に置き換えてください。この処理は、すべてのキーで実行してください。新規キーを「temperature」ではなく「temperature.celsius」という名前にするには、「response.weather.temperature_sep_celsius」と記載する必要があります。