API Gateway:ポリシーとプラグインの設定

スロットリングポリシー

クラウドネイティブ API Gateway は、API レベルとオペレーションレベルでスロットリングポリシーをサポートしています。これらのポリシーは、インバウンドリクエストがバックエンドサービスに過大な負荷をかけるのを防ぎ、カスケード障害の回避に役立ちます。高同時実行シナリオでは、スロットリングは一部のリクエストをブロックすることでバックエンドサービスの可用性を保護します。これにより、特定の期間内における各 API とオペレーションのリクエスト数を正確に制御し、その数が事前に設定されたしきい値を超えないようにします。

スロットリングポリシーには、同時実行制御、トラフィック制御、サーキットブレーカーが含まれます。

• 同時実行制御ポリシー：このポリシーは、同時リクエストの数を制限します。ゲートウェイで現在処理中のリクエストの総数をカウントすることで機能します。この数が設定されたしきい値に達すると、ゲートウェイは新しいトラフィックを直ちにブロックします。このしきい値を、バックエンドサービスが処理できる最大同時リクエスト数に合わせて設定すると、トラフィックスパイク時の可用性を保護できます。

  手順

  Add Policy ページで、[同時実行制御] カードをクリックします。[ポリシーの追加: 同時実行制御] パネルで、パラメーターを設定します。

  パラメーター			説明
  [Enable or Not]			同時実行制御ルールを有効にします。
  [Overall Concurrency Threshold]			Overall Concurrency Threshold を設定します。
  [Web Fallback Behavior]	[Return Specific Content]	[HTTP Status Code]	HTTP Status Code を設定します。デフォルト値は 429 です。
  		[Type of Returned Content]	Type of Returned Content を Regular Text または [JSON] に設定します。
  		[HTTP Text]	カスタムレスポンスボディのコンテンツです。
  	[Return Specific Content]	[Redirect URL]	Redirect URL を入力します。

• トラフィック制御ポリシー：このポリシーは、1 秒あたりのクエリ数 (QPS) に基づいてリクエストレートを制限します。API またはオペレーションの QPS を監視することで機能します。QPS が設定されたしきい値に達すると、ゲートウェイは新しいトラフィックを直ちにブロックします。これにより、バックエンドサービスが突然のトラフィックスパイクによって過負荷になるのを防ぎ、高可用性を確保します。

  手順

  Add Policy ページで、[トラフィック制御] カードをクリックします。 [ポリシーの追加: トラフィック制御] パネルで、パラメーターを設定します。

  パラメーター			説明
  [Enable or Not]			トラフィック制御ルールを有効にします。
  [Overall QPS Threshold]			Overall QPS Threshold を設定します。
  [Web Fallback Behavior]	[Return Specific Content]	[HTTP Status Code]	HTTP Status Code を設定します。デフォルト値は 429 です。
  		[Type of Returned Content]	Type of Returned Content を Regular Text または [JSON] に設定します。
  		[HTTP Text]	カスタムレスポンスボディのコンテンツです。
  	[Redirect to Specified Page]	[Redirect URL]	Redirect URL を入力します。

• サーキットブレーカーポリシー：このポリシーは、API やオペレーションの応答時間やエラー率を監視することで、バックエンドサービスを保護します。指定されたしきい値に達すると、ゲートウェイは回路を遮断し、不安定なサービスへのリクエストを直ちにフェイルファストさせることで、さらなる負荷を防ぎます。設定された期間が経過すると、ゲートウェイは「ハーフオープン」状態に入り、サービスが回復したかどうかを確認するために、限られた数のテストリクエストを許可します。サービスが安定していれば回路は閉じ、そうでなければ再び回路が遮断されます。

  サーキットブレーキングの状態は各ゲートウェイノードで個別に維持されます。各ノードが独自にリクエストをカウントして低速呼び出し率または例外率を計算するため、サーキットブレーキングのしきい値は、クラスター全体で集計されるのではなく、ノードごとに適用されます。Minimum Number of Requests、Statistical Window Duration、およびサーキットブレーキング率のしきい値を設定する際は、これらの値がゲートウェイクラスター全体としてではなく、単一ノードのローカル統計に適用される点にご注意ください。

  手順

  Add Policy ページで、[サーキットブレーカー] カードをクリックします。[ポリシーの追加: サーキットブレーカー] パネルで、パラメーターを設定します。

  パラメーター			説明
  [Enable or Not]			サーキットブレーカーのルールを有効にします。
  [Statistical Window Duration]			統計を収集する期間です。有効な値：1 秒～120 分。
  [Minimum Number of Requests]			統計ウィンドウ内でサーキットブレーカーをトリガーするために必要な最小リクエスト数です。リクエスト数がこの値を下回る場合、エラーのしきい値を満たしていてもサーキットブレーカーは遮断されません。
  [Threshold Type]			しきい値のタイプとして、Slow Call Ratio (%) または Exception Ratio (%) を選択します。 Slow Call Ratio (%) を選択した場合は、Slow Call RT (最大応答時間) を設定する必要があります。応答時間がこの値を超えたリクエストは、スローコールとしてカウントされます。ルールが有効な場合、統計期間内のリクエスト数が最小リクエスト数を超え、かつスローコールの割合がしきい値を超えると、サーキットがトリップされます。遮断期間が経過すると、サーキットブレーカーは回復試行 (半開) 状態になります。次のテストリクエストの応答時間が、指定されたスローコール RT 未満である場合、サーキットは復旧します。そうでない場合は、サーキットが再びトリップされます。 Exception Ratio (%) を選択した場合、エラー率のしきい値を設定する必要があります。ルールが有効な場合、統計期間内のリクエスト数が最小リクエスト数を超え、かつエラー率がしきい値を超えると、設定された期間、サーキットがトリップします。
  [Slow Call RT]			許容される Slow Call RT (つまり、最大応答時間) を設定します。
  [Circuit Breaking Ratio Threshold]			サーキットブレーカーをトリガーするスローコールまたはエラーの割合です。有効な値：0～100 (0%～100% を表します)。
  遮断期間 (秒)			回路が遮断された後、開いたままになる期間です。この期間中、リソースへのすべてのリクエストはフェイルファストします。
  [Web Fallback Behavior]	[Return Specific Content]	[HTTP Status Code]	HTTP Status Code を設定します。デフォルトは 429 です。
  		[Type of Returned Content]	Type of Returned Content を Regular Text または [JSON] に設定します。
  		[HTTP Text]	カスタムレスポンスボディのコンテンツです。
  	[Redirect to Specified Page]	[Redirect URL]	Redirect URL を入力します。

書き換えポリシー

書き換えポリシーを使用すると、リクエストをバックエンドサービスに転送する前に、リクエストパスとホスト名を変更できます。これにより、リクエストを正しいサービスまたはエンドポイントにルーティングし、特定のビジネス要件やアーキテクチャ要件を満たすことができます。

ヘッダー変更ポリシー

ヘッダー変更機能を使用すると、リクエストをバックエンドサービスに転送する前にリクエストヘッダーを変更したり、レスポンスをクライアントに返す前にレスポンスヘッダーを変更したりできます。

CORS ポリシー

オリジン間リソース共有 (CORS) は、Web アプリケーションサーバーがクロスオリジンアクセスを制御し、安全なデータ転送を可能にするセキュリティ機能です。クラウドネイティブ API Gateway は、API レベルとオペレーションレベルで CORS ポリシーをサポートしています。リソースにアクセスできるドメインとリクエストメソッドを指定できます。

トラフィックレプリケーションポリシー

トラフィックレプリケーションポリシーを使用すると、本番アプリケーションのトラフィックを指定されたサービスにコピーできます。この機能は、シミュレーションテストや問題の診断に役立ち、アプリケーションのパフォーマンス評価や障害のトラブルシューティングを行うことができます。

タイムアウトポリシー

クラウドネイティブ API Gateway は、API レベルおよびオペレーションレベルでタイムアウト設定を提供します。ゲートウェイがバックエンドサービスからの応答を待つ最大時間を設定できます。指定した時間内にゲートウェイが応答を受信しない場合、クライアントに HTTP 504 (Gateway Timeout) ステータスコードを返します。

リトライポリシー

Cloud-native API Gateway は、失敗したリクエストを自動的にリトライできるよう、API レベルおよびオペレーションレベルでリトライ設定を提供します。接続エラー、利用できないバックエンドサービス、または特定の HTTP ステータスコードでリトライをトリガーするなど、リトライ条件を設定できます。

API とオペレーションのリトライ条件

バックエンドサービスが 5xx エラーを返した場合、クラウドネイティブ API ゲートウェイは、設定された再試行回数に従って、失敗したリクエストを自動的に再試行します。

• HTTP プロトコルのリトライ条件は次のとおりです：

  • 5xx：バックエンドサービスが 5xx レスポンスを返した場合、接続が切断またはリセットされた場合、または読み取りタイムアウトが発生した場合、クラウドネイティブ API ゲートウェイは失敗したリクエストを再試行します。

    説明

    5xx 条件には、connect-failure と refused-stream が含まれます。

  • reset：接続が切断またはリセットされた場合、または読み取りタイムアウトが発生した場合、Cloud-native API Gateway は失敗したリクエストをリトライします。

  • connect-failure：接続が切断されたためにリクエストが失敗した場合、Cloud-native API Gateway は失敗したリクエストをリトライします。

  • refused-stream: バックエンドサービスが REFUSED_STREAM エラーコードでストリームをリセットした場合、Cloud-native API Gateway は失敗したリクエストを再試行します。

  • retriable-status-codes：バックエンドサービスからのレスポンスに含まれる HTTP ステータスコードが、指定したリトライステータスコードと一致する場合、Cloud-native API Gateway はリクエストをリトライします。

    説明

    リトライステータスコードは、リトライ条件として retriable-status-codes を選択した場合にのみ指定できます。

• gRPC プロトコルのリトライ条件は次のとおりです：

  • cancelled: バックエンド gRPC サービスからのレスポンスヘッダー内の gRPC ステータスコードが cancelled の場合、Cloud-native API Gateway はリクエストを再試行します。

  • deadline-exceeded: バックエンド gRPC サービスからのレスポンスヘッダーに含まれる gRPC ステータスコードが deadline-exceeded の場合、クラウドネイティブ API ゲートウェイはリクエストを再試行します。

  • internal: バックエンド gRPC サービスからのレスポンスヘッダー内の gRPC ステータスコードが internal の場合、Cloud-native API Gateway はリクエストを再試行します。

  • resource-exhausted: バックエンド gRPC サービスからのレスポンスヘッダー内の gRPC ステータスコードが resource-exhausted である場合、クラウドネイティブ API ゲートウェイはリクエストを再試行します。

  • unavailable: バックエンド gRPC サービスからのレスポンスヘッダー内の gRPC ステータスコードが unavailable の場合、クラウドネイティブ API ゲートウェイはリクエストを再試行します。