API Gateway:リトライポリシーの構成

ルートリトライ条件

バックエンドサービスが 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：バックエンドが cancelled gRPC ステータスを返した場合にリトライします。

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

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

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

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

ルートリトライポリシーの構成

1. API がゲートウェイインスタンス内にあるか外にあるかに応じて、タブを選択します。

   インスタンス外の API

   1. Cloud-native API Gateway コンソール にログインします。左側のナビゲーションウィンドウで API を選択し、リージョンを選択します。

   2. 対象の API をクリックします。ドロップダウンリストから対象のインスタンスを選択するか、すべてのインスタンス を選択します。

   3. Routes から対象のルートを選択します。

   インスタンス内の API

   1. Cloud-native API Gateway コンソール にログインします。左側のナビゲーションウィンドウで インスタンス を選択し、リージョンを選択します。

   2. インスタンス ページで、対象のゲートウェイインスタンス ID をクリックします。左側のナビゲーションウィンドウで API を選択し、対象の API をクリックします。

   3. Routes から対象のルートを選択します。

2. Configure Policy タブをクリックします。Inbound Processing セクションで、Enable Policy/Plug-in をクリックします。

3. Retry カードをクリックします。Add Policy: Retry パネルでパラメーターを構成し、Add をクリックします。

   説明

   リトライポリシーを有効化した後は、期待どおりに動作することを確認してください。

   Parameter	Description
   Enable	リトライポリシーを有効または無効にします。 有効：ポリシーがアクティブになります。 無効：ポリシーが非アクティブになります。 説明 無効にすると、ゲートウェイはデフォルトのリトライ構成を適用します。最大 2 回の試行を行い、条件は connect-failure、refused-stream、unavailable、cancelled、および retriable-status-codes です。
   Retry Times	失敗したリクエストに対する最大リトライ回数です。有効値：0 ～ 10（整数）。推奨値：2 以下。 説明 値を 0 に設定すると、リトライは無効になります。
   Retry Condition	ルートリトライ条件 リストから 1 つ以上のリトライ条件を選択します。
   Retry Status Code	リトライをトリガーする HTTP ステータスコードです。複数の値を入力できます。 説明 Retry Condition は、retriable-status-codes が Retry Status Code として選択されている場合にのみ構成できます。