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

速度制限ポリシー

クラウドネイティブ API ゲートウェイは、API および操作レベルでの速度制限ポリシーの実装をサポートしており、外部リクエストがバックエンドサービスのキャパシティを超えるのを効果的に防ぎ、カスケード障害を回避します。速度制限機能は、同時リクエスト数が多い場合に一部のリクエストをブロックするのに役立ちます。これにより、バックエンドサービスの可用性が確保されます。指定された期間内に各 API と操作のリクエスト数を正確に制御し、事前に設定されたしきい値を超えないようにすることができます。

速度制限ポリシーには、同時実行数制御、トラフィック制御、サーキットブレーカーポリシーが含まれます。

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

  操作手順

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

  パラメーター			説明
  [有効化]			このスイッチをオンにすると、同時実行数制御ルールが有効になります。
  全体の同時実行しきい値			[全体の同時実行数のしきい値] を設定します。
  ウェブフォールバック動作	[指定されたコンテンツを返す]	HTTP ステータスコード	[HTTP ステータスコード] を設定します。デフォルト値は 429 です。
  		返却 Content-Type	[返す Content-type] として [プレーンテキスト] または [JSON] を選択します。
  		HTTP 応答テキスト	返されるテキストを入力します。
  	指定コンテンツの返却	リダイレクト URL	[リダイレクト URL] を入力します。

• トラフィック制御ポリシー：トラフィック制御ルールは、API と操作の QPS メトリックを監視することで機能します。メトリックが設定されたしきい値に達すると、トラフィックは即座にブロックされ、バックエンドサービスが突然のトラフィックスパイクによって圧倒されるのを防ぎ、高可用性を確保します。

  操作手順

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

  パラメーター			説明
  [有効化]			スイッチをオンにすると、トラフィック制御ポリシーが有効になります。
  全体 QPS しきい値			[全体の QPS のしきい値] を設定します。
  [Web フォールバック動作]	[指定されたコンテンツを返す]	HTTP ステータスコード	[HTTP ステータスコード] を設定します。デフォルト値は 429 です。
  		返却コンテンツタイプ	[プレーンテキスト] または [JSON] を [戻り値の Content-type] として選択します。
  		[HTTP 応答テキスト]	返されるテキストを入力します。
  	[指定されたページにリダイレクト]	リダイレクト URL	[リダイレクト URL] を入力します。

• サーキットブレーカーポリシー：サーキットブレーカールールは、API と操作の応答時間またはエラー率を監視することで機能します。指定されたしきい値に達すると、依存関係の優先度が即座に低下します。サーキットブレーカーがトリガーされると、システムは指定された期間、ルート上のリクエストを呼び出しません。これにより、バックエンドサービスの高可用性が確保されます。指定された期間が経過すると、システムはルート上のリクエストの呼び出しを再開します。

  操作手順

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

  パラメーター			説明
  [有効化]			このスイッチをオンにすると、設定された速度制限ルールが有効になります。
  [統計期間]			タイムウィンドウの長さ。有効値は 1 秒から 120 分です。
  最小リクエスト数			サーキットブレーカーをトリガーするための最小リクエスト数。現在のタイムウィンドウ内のリクエスト数がこのパラメーターの値より少ない場合、サーキットブレーカールールが満たされていてもサーキットブレーカーはトリガーされません。
  しきい値タイプ			しきい値として [低速呼び出し率 (%)] または [エラー率 (%)] を選択します。 しきい値として [低速呼び出し率 (%)] を選択した場合、許容される [低速呼び出しの RT] (最大応答時間) を設定する必要があります。応答時間がこの値より大きいリクエストは、低速呼び出しとしてカウントされます。サービス低下のしきい値を低速呼び出しの割合のしきい値に設定します。サーキットブレーカールールが有効になった後、指定された期間に開始されたリクエストの数が指定された最小リクエスト数より多く、低速呼び出しの割合が指定されたしきい値より大きい場合、次のサーキットブレーカー期間で処理されるリクエストに対してサーキットブレーカーが自動的に実装されます。サーキットブレーカー期間が経過すると、サーキットブレーカーは次のリクエストの RT の検出を開始します。次のリクエストの RT が低速呼び出しの RT パラメーターの値より小さい場合、サーキットブレーカーは終了します。次のリクエストの RT が低速呼び出しの RT パラメーターの値より大きい場合、サーキットブレーカーが再度トリガーされます。 しきい値として [エラー率 (%)] を選択した場合、サービス低下のしきい値をエラーの割合のしきい値に設定する必要があります。ルールが有効になった後、指定された期間内の例外リクエストの数が指定された最小リクエスト数より多く、例外リクエストの割合が指定されたしきい値より大きい場合、次のサーキットブレーカー期間で処理されるリクエストに対してサーキットブレーカーが自動的に実装されます。
  スローコールの応答時間			許容される [低速呼び出しの RT] (最大応答時間) を設定します。
  [サーキットブレーカーのしきい値]			低速呼び出しの割合のしきい値。指定されたしきい値に達するか超えた場合、サーキットブレーカーがトリガーされます。有効値：0～100。これらの値は 0% から 100% を表します。
  [サーキットブレーカー期間 (秒)]			サーキットブレーカーが実装される期間。リソースに対してサーキットブレーカーが実装されると、設定された期間中、すべてのリソースへの呼び出しが失敗します。
  ウェブフォールバック動作	[指定されたコンテンツを返す]	HTTP ステータスコード	[HTTP ステータスコード] を設定します。デフォルト値は 429 です。
  		[返す Content-type]	[返す Content-type] として [プレーンテキスト] または [JSON] を選択します。
  		[HTTP 応答テキスト]	返されるテキストを入力します。
  	[指定されたページにリダイレクト]	[リダイレクト URL]	[リダイレクト URL] を入力します。

書き換えポリシー

書き換えポリシーを設定して、リクエストが宛先のバックエンドサービスに転送される前に、リクエストのパスとホスト名を柔軟に変更できます。これにより、特定のビジネス環境やアーキテクチャの要件を満たすことができます。書き換えポリシーを使用すると、リクエストのパスとホスト名を正確に制御し、リクエストが適切なサービスまたはエンドポイントに正しくルーティングされるようにすることができます。

ヘッダー設定ポリシー

ヘッダー設定ポリシーを設定して、リクエストが宛先のバックエンドサービスに転送される前、またはバックエンドサービスの応答がクライアントに返される前に、リクエストまたは応答のヘッダーを変更できます。

オリジン間リソース共有 (CORS) ポリシー

CORS は、Web アプリケーションサーバーがオリジン間アクセス制御を実行できるようにする重要なセキュリティポリシーです。これにより、安全なデータ転送が実現します。クラウドネイティブ API ゲートウェイは、API および操作レベルでの CORS ポリシーの設定をサポートしています。ビジネス要件に基づいて、リソースへのアクセスを許可するドメイン名とリクエストメソッドを制限できます。

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

トラフィックレプリケーションポリシーを使用すると、オンラインアプリケーションのトラフィックを指定されたサービスに複製できます。この機能は、システムのシミュレーションテストと障害特定をサポートし、アプリケーションのパフォーマンスを効率的に評価し、問題をトラブルシューティングするのに役立ちます。

タイムアウトポリシー

クラウドネイティブ API ゲートウェイは、API および操作レベルでタイムアウト設定を提供します。指定された API と操作のリクエストに対する応答をゲートウェイが待機する最大期間を設定できます。ゲートウェイが指定された期間内にバックエンドサービスから応答を受信しない場合、ゲートウェイはクライアントに 504 (ゲートウェイタイムアウト) HTTP ステータスコードを返します。

リトライポリシー

クラウドネイティブ API ゲートウェイは、失敗したリクエストを自動的にリトライするために、API および操作レベルでリトライ設定を提供します。接続の失敗、バックエンドサービスが利用できない、または指定された HTTP ステータスコードを持つ応答など、リトライ条件を設定できます。

API と操作のリトライ条件

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

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

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

    説明

    5xx には connect-failure および refused-stream 条件が含まれます。

  • [reset]：接続が切断またはリセットされるか、読み取りタイムアウトが発生した場合、クラウドネイティブ API ゲートウェイは失敗したリクエストのリトライを試みます。

  • [connect-failure]：接続が切断されたためにリクエストが失敗した場合、クラウドネイティブ API ゲートウェイは失敗したリクエストのリトライを試みます。

  • [refused-stream]：バックエンドサービスが REFUSED_STREAM エラーコードでストリームをリセットした場合、クラウドネイティブ API ゲートウェイは失敗したリクエストのリトライを試みます。

  • [retriable-status-codes]：バックエンドサービスからの応答の HTTP ステータスコードが指定したリトライステータスコードと一致する場合、クラウドネイティブ API ゲートウェイはリクエストのリトライを試みます。

    説明

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

• [GRPC プロトコル] のリトライ条件は次のとおりです。

  • [cancelled]：バックエンド gRPC サービスからの応答ヘッダーの gRPC ステータスコードが cancelled の場合、クラウドネイティブ API ゲートウェイはリクエストのリトライを試みます。

  • [deadline-exceeded]：バックエンド gRPC サービスからの応答ヘッダーの gRPC ステータスコードが deadline-exceeded の場合、クラウドネイティブ API ゲートウェイはリクエストのリトライを試みます。

  • [internal]：バックエンド gRPC サービスからの応答ヘッダーの gRPC ステータスコードが internal の場合、クラウドネイティブ API ゲートウェイはリクエストのリトライを試みます。

  • [resource-exhausted]：バックエンド gRPC サービスからの応答ヘッダーの gRPC ステータスコードが resource-exhausted の場合、クラウドネイティブ API ゲートウェイはリクエストのリトライを試みます。

  • [unavailable]：バックエンド gRPC サービスからの応答ヘッダーの gRPC ステータスコードが unavailable の場合、クラウドネイティブ API ゲートウェイはリクエストのリトライを試みます。