メインコンテンツまでスキップ

Timeout

概要

Timeoutポリシーは、クライアントとAPIサーバー間の通信のさまざまな段階に対する時間制限を定義するために使用されます。API呼び出しが指定された期間のいずれかを超えると、タイムアウトエラーがトリガーされ、リクエストは失敗します。

このポリシーは、システムを長時間ハングするリクエストから保護し、ネットワーク操作に対する上限時間を強制します。

設定の詳細

Field Description
ConnectionTimeoutクライアントとサーバー間の接続を確立するための時間制限。この時間内に接続が確立できない場合、タイムアウトエラーが返されます。
WriteTimeout接続が確立された後、クライアントがサーバーにデータを送信(書き込み)するための時間制限。書き込みに時間がかかりすぎると、タイムアウトエラーが発生します。
ReadTimeout接続が確立された後、サーバーからの応答を読み取るための時間制限。読み取りに時間がかかりすぎると、タイムアウトエラーがトリガーされます。
注記

変更できません: このポリシーが削除されないようにするためのトグル。

設定値を変更できません: 設定後に構成値の変更を防ぐためのトグル。

すべての時間値はミリ秒単位です。

すべてのタイムアウトのデフォルト値は60000ms(60秒)です。

値を0に設定すると、そのフェーズのタイムアウトが無効になります(タイムアウトなしと同等)。

タイムアウトロジックの概要

  • ConnectionTimeout は、接続確立中の長時間の遅延を防ぐために使用されます。
  • WriteTimeout は、データの送信(例: リクエストボディ)が無限に長くならないことを保証します。
  • ReadTimeout は、接続が確立された後にAPIが時間内に応答することを保証します。