- 基本情報
- Swagger 定義
- Orchestrator API の使用例
レート制限
- 予測可能なシステムを確保: API 呼び出しの制限を知ることで、アプリケーションの設計と保守を改善できます。 予測可能な環境を提供し、予期しない制限違反による想定外の事態を最小限に抑えます。
- パフォーマンスの向上: サーバー上のトラフィックを制御することにより、最適なパフォーマンスと迅速な応答を保証し、製品エクスペリエンスを大幅に向上させます。
- セキュリティの強化: 以下に概説する制限は、セキュリティの追加レイヤーとして機能し、潜在的なサイバー脅威からシステムを保護します。
- 公正な使用を保証: レート制限により、すべてのユーザーに公平なリソース割り当てが保証され、使用のピーク時でもスムーズな運用が保証されます。
以下に概説する制限は、お客様側でいくつかの調整をしていただく必要がありますが、長期的にはメリットをもたらすことになるものです。
適用される制限は次のとおりです。
|
エンドポイント |
上限量 |
発効日 |
|---|---|---|
|
|
100 API 要求/分/テナント |
2024 年 7 月 |
|
| 100 API 要求/分/テナント | 2024 年 7 月 |
ただしこれらの制限は、キュー アイテムの追加やジョブの処理には適用されません。したがって、キュー アイテムの追加、キューからのアイテムの削除、ステータスの設定、任意の数のジョブの開始/処理には影響しません。
月または日ごとの API 使用状況は、テナント レベルの [監視] ウィンドウの [API 監査] タブで確認できます。
|
ヘッダー |
説明 |
例 |
|---|---|---|
|
|
前述の制限を超えるすべての要求は、このヘッダーを含む HTTP 429 応答を返します。 エンドポイントが再び利用可能になるまで待機する必要のある秒数が表示されます。 |
Retry-After: 10 エンドポイントのレート制限が 10 秒で期限切れになることを意味します。この 10 秒以内に再試行すると、応答は 429 になります。
|
|
|
残りの呼び出し数 |
X-RateLimit-Remaining: 30 現在の時間範囲に 30 件の呼び出しが残っていることを意味します。
|
1 分あたりの要求数が 10 未満の場合は、0 としてレンダリングされます。
この制限により、以下のアクティビティが影響を受けます。
- ジョブを取得
- キュー アイテムを取得
- Orchestrator への HTTP 要求 (
GET /odata/JobsまたはGET /odata/QueueItemsエンドポイントの呼び出しに使用される場合)
以下は、制限を遵守すると同時に、制限を最大限に活用していただくための推奨事項です。
- API の使用パターンと、前述の
GetAllタイプのエンドポイントから取得した情報を確認します。 - 必要に応じて、API 呼び出しの頻度とデータ抽出手順を調整して、これらの制限に合わせてください。
- ジョブおよびキュー アイテムのデータを取得する例については、「ジョブをエクスポートする」および「キュー アイテムをエクスポートする」をご覧ください。
- Insights のリアルタイムのデータ エクスポート オプションを使用します。
- 質問がある場合、またはさらに説明が必要な場合は、アカウント マネージャーまたはサポートチームにお問い合わせください。
ジョブやキュー アイテムのリストの取得に使用される API エンドポイントを、リアルタイムの監視やデータのエクスポートに使用すると、問題が発生する可能性があります。以下に例を示します。
-
最大 1,000 個のアイテムを要求し、各アイテムが最大 1 MB の大きなデータに相当する場合、1 回の API 呼び出しに対する応答のサイズが 1 GB 程度になる可能性があります。このサイズの応答を許可しない中継点があるため、要求は失敗します。
-
複雑なフィルターを使用し、数百万個のキュー アイテムを含むキューにページネーションを行うと、数十ページを処理した後に要求がタイムアウトし始める場合があります。これは、データベースから取得する必要があるデータの量が原因です。
GetAll エンドポイントの応答から特定のデータが省略されています。影響を受けるフィールドは次のとおりです。
|
エンドポイント |
省略されたフィールド |
代わりに使用できるもの |
発効日 |
|---|---|---|---|
|
|
|
エクスポートには、次の専用のエンドポイントを使用します。
GET/odata/Jobs/UiPath.Server.Configuration.Data.Export詳しくは、「ジョブをエクスポートする」をご覧ください。 |
Community およびカナリア テナント: 2024 年 3 月 Enterprise テナント: 2024 年 7 月 |
|
|
|
エクスポートには、次の専用のエンドポイントを使用します。
/odata/QueueDefinitions
({key})/UiPathDataSvc.Export詳しくは、「キュー アイテムをエクスポートする」をご覧ください。 |
Community およびカナリア テナント: 2024 年 3 月 Enterprise テナント: 2024 年 7 月 |
GET /odata/Jobs または GET
/odata/QueueItems エンドポイントを使用している場合は、上記のフィールドのいずれかを使用しているかどうかを確認する必要があります。その場合、該当するフィールドの中身は null として返されますのでご注意ください。
カナリア テナントでプロセスをテストして、影響を評価することをお勧めします。
フィールドを取得するには、次の代替方法があります。
- ジョブおよびキュー アイテムのデータを取得する例については、「ジョブをエクスポートする」および「キュー アイテムをエクスポートする」をご覧ください。
- Insights のリアルタイムのデータ エクスポート オプションを使用します。
- 前述の方法がうまくいかない場合は、アカウントマネージャーまたはサポート チームにご連絡ください。
レート制限と大きなデータ フィールドの変更は、オンプレミス環境では実装されません。
スタンドアロンの Orchestrator を使用しておりクラウドへの移行を検討している場合は、IIS 要求ログを使用して、影響を受けるエンドポイントに対する要求レートを確認できます。分析はログの集計方法によって異なりますが、Microsoft Log Parser などを使用できます。
大きなデータ フィールドへの影響を評価するには、カナリア テナントでプロセスをテストすることをお勧めします。
