レート制限

レート制限

ほとんどのBox APIには、サードパーティのサービスやユーザーによる乱用を防ぐためのレート制限が設けられています。

APIごとのレート制限

現在、Box APIにはいくつかの異なるレート制限があります。

  • 一般的なAPI呼び出し

    • 1ユーザーあたりのAPIリクエストは1000件/分
  • アップロード

    • 1ユーザーあたりのファイルアップロードリクエストは240件/分
  • 検索

    • 検索エンドポイントに対して、1ユーザーあたりの検索数は6件/秒
    • 基本のレート制限に加えてさらに2つの制限が適用されます
    • 1ユーザーあたりの検索数は60件/分
    • 会社あたりの検索数は12件/秒

レート制限エラー

アプリケーションがレート制限に達すると、APIは、HTTPステータスコードが429 Too Many RequestsのAPI応答を返します。

応答には以下のヘッダーとJSON本文が含まれます。

retry-after: 100
{
  "type": "error",
  "status": 429,
  "code": "rate_limit_exceeded",
  "help_url": "http://developers.box.com/docs/#errors",
  "message": "Request rate limit exceeded, please try again later",
  "request_id": "abcdef123456"
}

詳細については、クライアントエラーのリソースを参照してください。

retry-afterヘッダーでは、次のAPI呼び出しが再試行可能になるまで待機する秒数を指示します。一般的には、API呼び出しの再試行に指数バックオフ戦略を使用することをお勧めします。