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：レスポンスヘッダー内の gRPC ステータスコードが cancelled の場合。

  • deadline-exceeded：レスポンスヘッダー内の gRPC ステータスコードが deadline-exceeded の場合。

  • internal：レスポンスヘッダー内の gRPC ステータスコードが internal の場合。

  • resource-exhausted：レスポンスヘッダー内の gRPC ステータスコードが resource-exhausted の場合。

  • unavailable：レスポンスヘッダー内の gRPC ステータスコードが unavailable の場合。

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

1. API の管理方法に応じて、以下のいずれかの方法でリトライポリシーを構成できます。

   インスタンス外の API

   1. Cloud-native API Gateway コンソール にログインします。左側のナビゲーションウィンドウで API をクリックし、上部のメニューバーからリージョンを選択します。

   2. HTTP API ページで、上部のドロップダウンリストを使用してターゲットインスタンスを選択します。特定のインスタンスまたは すべてのインスタンス を選択できます。

   3. Routes で、対象のルートをクリックします。

   インスタンス内の API

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

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

   3. Routes で、対象のルートをクリックします。

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

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

   説明

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

   パラメーター	説明
   Enable	リトライポリシーを有効または無効にします。 有効：リトライポリシーがアクティブになります。 無効：リトライポリシーが非アクティブになります。 説明 このポリシーが無効の場合、ゲートウェイはデフォルトのリトライ構成を使用します。デフォルトのリトライ回数は 2 回で、デフォルトリトライ条件は connect-failure、refused-stream、unavailable、cancelled、および retriable-status-codes です。
   Retry Times	失敗したリクエストに対する最大リトライ回数です。有効値：0 ～ 10。2 以下を推奨します。 説明 0 を指定すると、リトライは無効になります。
   Retry Condition	リトライをトリガーする条件です。複数の条件を選択できます。詳細については、「リトライ条件」をご参照ください。
   Retry Status Code	リトライをトリガーする HTTP ステータスコードです。複数のコードを指定できます。 説明 再試行状態コード パラメーターは、Retry Condition に retriable-status-codes が選択されている場合にのみ構成できます。