状態チェックポリシー

ポリシー名

状態チェック

Summary (概要)

特定の間隔で API アップストリームの健全性を監視する

カテゴリ

サービス品質

使用可能な最小 Flex Gateway バージョン

v1.4.0

返される状況コード

このポリシーの戻りコードは存在しません。

概要

状態チェックポリシーを使用すると、アップストリームサービスへの API インスタンスの接続を監視でき、接続状況が変わった場合にメールアラートが送信されます。状態チェックポリシーでは、アップストリームサービスの状態が監視され、API インスタンスや Flex Gateway の状態は監視されません。

状態チェックポリシーでは、指定されたアップストリームのベースパスに対して GET 要求を実行することで API を監視します。GET 要求でベースパスを指定する必要があります。要求は最初の要求を含めて固定されたスケジュールで 1 分ごとに実行されます。最初の要求はポリシーが適用されてから 1 分後に実行されます。状態チェックポリシーによって行われた要求は、価格設定を目的として Flex Gateway API コールに含まれません。

状態チェックを設定する場合、健全な接続を示す GET 要求の応答コードを指定します。たとえば、アクティブな API の状況コードでは 200 が返されます。これは、API で接続を受信できることを示します。状況コードが 200 以外の場合、プラットフォームによりメールアラートが送信されます。状態チェックでは応答コードのみを検証するため、エンドポイントに何が返されるかは重要ではありません。

健全な応答についてはログイベントが表示されません。Flex Gateway では、健全でない応答のみが記録されます。

1xx、2xx、3xx、4xx、または 5xx の任意の応答コードを使用できます。ただし、エンドポイントへの正常な接続が想定される場合は、2xx の応答コードを使用することをお勧めします。数値の応答コードのみが受け入れられます。

状態チェックポリシーのアラートを作成する必要があります。ポリシーを適用すると、[Create Alert (アラートを作成)] ページに移動します。ここで、アラートを作成する必要があります。アラートの設定方法についての詳細は、​「Flex Gateway API アラートの使用」​にアクセスしてください。

状態チェックポリシーを、アウトバウンド TLS コンテキストも適用されている API インスタンスに適用すると、状態チェックポリシーでは健全ではない接続が返されます。

ポリシーのパラメーターの設定

Flex Gateway のローカルモード

状態チェックポリシーは、ローカルモードではサポートされません。

Flex Gateway の接続モード

UI からポリシーを API に適用するときに、パラメーターのリストが表示されます。

要素 説明 必須?

Upstream URL (アップストリーム URL)

監視している API アップストリームの完全な URL

はい

Base Path (ベースパス)

状態チェック中に要求される GET メソッドの HTTP パス。

はい

Response code (応答コード)

ベースパスで指定された GET 要求の想定される状況コード。数値の応答コードのみが受け入れられます。

はい