すべてのプロダクト
Search
ドキュメントセンター

API Gateway:リトライポリシーの設定

最終更新日:Dec 18, 2025

Cloud-native API Gateway では、ルートレベルのリトライポリシーを設定できます。これにより、失敗したリクエストの自動リトライが可能になります。リトライポリシーでは、接続の失敗、バックエンドサービスが利用不可、または特定の HTTP ステータスコードを持つレスポンスなどのリトライ条件を指定できます。

リトライ条件

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

image
  • HTTP プロトコルのリトライ条件:

    • 5xx:バックエンドサービスが 5xx レスポンスを返すか、接続が切断、リセット、または読み取り操作中にタイムアウトした場合、Cloud-native API Gateway は失敗したリクエストのリトライを試みます。

      説明

      5xx には、connect-failurerefused-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 の場合、Cloud-native API Gateway はリクエストのリトライを試みます。

    • internal:バックエンドの gRPC サービスからのレスポンスヘッダーに含まれる gRPC ステータスコードが internal の場合、Cloud-native API Gateway はリクエストのリトライを試みます。

    • resource-exhausted:バックエンドの gRPC サービスからのレスポンスヘッダーに含まれる gRPC ステータスコードが resource-exhausted の場合、Cloud-native API Gateway はリクエストのリトライを試みます。

    • unavailable:バックエンドの gRPC サービスからのレスポンスヘッダーに含まれる gRPC ステータスコードが unavailable の場合、Cloud-native API Gateway はリクエストのリトライを試みます。

リトライポリシーの設定

  1. Cloud-native API Gateway では、インスタンス外とインスタンス内の 2 つの方法でリトライポリシーを設定できます。

    インスタンス外の API

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

    2. ターゲット API をクリックします。ドロップダウンリストからリトライポリシーを設定したいインスタンスを選択するか、[すべてのインスタンス] を選択できます。image

    3. [ルートリスト] からターゲットルートを選択します。

    インスタンス内の API

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

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

    3. [ルート] タブで、ターゲットルートを選択します。

  2. [ポリシー設定] タブをクリックし、[インバウンド処理] セクションの [ポリシー/プラグインの有効化] をクリックします。

  3. [リトライ] カードをクリックします。[ポリシーの追加:リトライ] パネルでパラメーターを設定し、[OK] をクリックします。

    説明

    リトライポリシーを作成して有効化した後、ビジネス要件に基づいてリトライポリシーが有効かどうかを確認できます。

    パラメーター

    説明

    有効化

    リトライポリシーを有効にするかどうかを指定します。

    • スイッチをオンにすると、リトライポリシーが有効になります。

    • スイッチをオフにすると、リトライポリシーは有効になりません。

    説明

    リトライを無効にすると、ゲートウェイはデフォルトのリトライ構成を使用します。デフォルトの最大リトライ回数は 2 で、デフォルトのリトライ条件は connect-failurerefused-streamunavailablecancelled、および retriable-status-codes です。

    リトライ回数

    失敗したリクエストの最大リトライ回数。0 から 10 までの整数を設定できます。このパラメーターは 0、1、または 2 に設定することを推奨します。

    説明

    このパラメーターを 0 に設定すると、失敗したリクエストはリトライされません。

    リトライ間隔 (秒)

    リトライをトリガーする条件。1 つ以上の条件を選択できます。詳細については、「リトライ条件」をご参照ください。

    リトライステータスコード

    リトライをトリガーする HTTP ステータスコード。1 つ以上の HTTP ステータスコードを指定できます。

    説明

    Retry Status Code は、[リトライ条件]retriable-status-codes を指定した場合にのみ設定できます。