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

スロットリングポリシー

スロットリングは、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 または [application/json] のいずれかを選択します。
  		[HTTP Text]	レスポンスボディのコンテンツを入力します。
  	[Return Specific Content]	[Redirect URL]	Redirect URL を入力します。

• トラフィックシェーピングポリシー： 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 または application/json を選択します。
  		[HTTP Text]	レスポンスボディのコンテンツを入力します。
  	[Redirect to Specified Page]	[Redirect URL]	Redirect URL を入力します。

• サーキットブレークポリシー： API とオペレーションのレスポンス時間またはエラー率を監視します。しきい値に達すると、サーキットブレーカーが作動し、連鎖的な障害を防ぐために設定された期間、後続のリクエストを失敗させます。タイムアウト後、ゲートウェイは限られた数のテストリクエストを許可し、バックエンドが回復したかどうかを確認します。

  手順

  Add Policy ページで、Add Policy カードをクリックします。Add Policy パネルで、次のパラメーターを設定します。

  パラメーター			説明
  [Enable or Not]			サーキットブレークポリシーを有効にします。
  [Statistical Window Duration]			統計分析のための時間枠。有効値： 1 秒～120 分。
  [Minimum Number of Requests]			Minimum number of requests within a time window required to trigger circuit breaking. If the count is below this value, circuit breaking is not triggered even if the threshold is met.
  [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%)。
  遮断期間 (s)			トリップ後にサーキットが開いたままになる期間。この期間中、リクエストは即座に失敗します (フェイルファスト)。
  [Web Fallback Behavior]	[Return Specific Content]	[HTTP Status Code]	Sets the [HTTP Status Code] for the response. The default is 429.
  		[Type of Returned Content]	Type of Returned Contentで、Regular Textまたは [application/json] を選択します。
  		[HTTP Text]	レスポンスボディのコンテンツを入力します。
  	[Redirect to Specified Page]	[Redirect URL]	Enter the [Redirect URL].

書き換えポリシー

書き換えポリシーは、バックエンドサービスに転送する前にリクエストパスとホストヘッダーを書き換え、リクエストを正しいエンドポイントに到達させます。

ヘッダー変更ポリシー

ヘッダー変更では、バックエンドに転送する前のリクエストヘッダー、またはクライアントに返す前のレスポンスヘッダーを変更できます。

CORS ポリシー

オリジン間リソース共有 (CORS) は、異なるオリジン (ドメイン、スキーム、またはポート) からのリソースへのアクセスを制御します。API レベルおよびオペレーションレベルで CORS ポリシーを設定し、許可されたオリジンとリクエストメソッドを指定します。

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

トラフィックレプリケーションは、シミュレーションテストや障害診断のために、ライブトラフィックの一定の割合を指定のサービスにミラーリングします。

タイムアウトポリシー

ゲートウェイがバックエンドのレスポンスを待機する最大時間を設定します。この時間内にレスポンスが受信されない場合、ゲートウェイは HTTP 504 (Gateway Timeout) エラーを返します。

リトライポリシー

失敗したリクエストに対して自動リトライを設定します。リトライ条件には、接続失敗、バックエンドサービスの利用不可、特定の HTTP ステータスコードが含まれます。

リトライ条件

バックエンドサービスが 5xx エラーを返した場合、Cloud-native API Gateway は、設定されたリトライ回数に従って失敗したリクエストを自動的にリトライします。

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

  • 5xx：バックエンドサービスが 5xx 応答を返した場合、ゲートウェイはリクエストをリトライします。

    説明

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

  • reset：接続が切断、リセット、またはタイムアウトした場合、ゲートウェイはリクエストをリトライします。

  • connect-failure：接続に失敗した場合、ゲートウェイはリクエストをリトライします。

  • refused-stream：バックエンドサービスが REFUSED_STREAM エラーコードを返してストリームをリセットした場合、ゲートウェイはリクエストをリトライします。

  • retriable-status-codes：応答の HTTP ステータスコードがユーザー指定のステータスコードのいずれかと一致する場合、ゲートウェイはリクエストをリトライします。

    説明

    リトライステータスコードは、リトライ条件で retriable-status-codes が指定されている場合にのみ使用できます。

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

  • cancelled：バックエンドの gRPC サービスが cancelled を返した場合にリトライします。

  • deadline-exceeded：バックエンドの gRPC サービスが deadline-exceeded を返した場合にリトライします。

  • internal：バックエンドの gRPC サービスが internal を返した場合にリトライします。

  • resource-exhausted：バックエンドの gRPC サービスが resource-exhausted を返した場合にリトライします。

  • unavailable：バックエンドの gRPC サービスが unavailable を返した場合にリトライします。