- 基本情報
- はじめに
- OData と参照について
- Orchestrator URL
- API リファレンス
- Rate limits and large data fields usage optimization
- 論理リソースとメタデータ
- 使用可能な操作
- 列挙型
- クラウド API の利用
- API リクエストを構築する
- 外部アプリケーション (OAuth)
- エンドポイントごとの権限
- 応答コード
- Swagger 定義
- Orchestrator API の使用例
Rate limits and large data fields usage optimization
- 予測可能なシステムを確保: API 呼び出しの制限を知ることで、アプリケーションの設計と保守を改善できます。 予測可能な環境を提供し、予期しない制限違反による想定外の事態を最小限に抑えます。
- パフォーマンスの向上: サーバー上のトラフィックを制御することにより、最適なパフォーマンスと迅速な応答を保証し、製品エクスペリエンスを大幅に向上させます。
- セキュリティの強化: 以下に概説する制限は、セキュリティの追加レイヤーとして機能し、潜在的なサイバー脅威からシステムを保護します。
- 公正な使用を保証: レート制限により、すべてのユーザーに公平なリソース割り当てが保証され、使用のピーク時でもスムーズな運用が保証されます。
The limits and large data fields optimizations outlined below require some adjustments on your end, but we are confident that they will bring long-term benefits.
適用される制限は次のとおりです。
|
エンドポイント |
例 |
上限量 |
発効日 |
|---|---|---|---|
|
|
|
100 API 要求/分/テナント |
2024 年 7 月 |
|
|
| 100 API 要求/分/テナント | 2024 年 7 月 |
GET/odata/Jobs(<job_id>) is not rate limited.
ただしこれらの制限は、キュー アイテムの追加やジョブの処理には適用されません。したがって、キュー アイテムの追加、キューからのアイテムの削除、ステータスの設定、任意の数のジョブの開始/処理には影響しません。
月または日ごとの 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エンドポイントの呼び出しに使用される場合)
Retry-after response header, meaning that they perform automatic retries of Orchestrator operations. Please make sure to always use the latest version of System activities to benefit from this.
以下は、制限を遵守すると同時に、制限を最大限に活用していただくための推奨事項です。
- API の使用パターンと、前述の
GetAllタイプのエンドポイントから取得した情報を確認します。 - 必要に応じて、API 呼び出しの頻度とデータ抽出手順を調整して、これらの制限に合わせてください。
- ジョブおよびキュー アイテムのデータを取得する例については、「ジョブをエクスポートする」および「キュー アイテムをエクスポートする」をご覧ください。
- Insights のリアルタイムのデータ エクスポート オプションを使用します。
- Make sure you always use the latest version of System activities.
- 質問がある場合、またはさらに説明が必要な場合は、アカウント マネージャーまたはサポートチームにお問い合わせください。
ジョブやキュー アイテムのリストの取得に使用される API エンドポイントを、リアルタイムの監視やデータのエクスポートに使用すると、問題が発生する可能性があります。以下に例を示します。
-
最大 1,000 個のアイテムを要求し、各アイテムが最大 1 MB の大きなデータに相当する場合、1 回の API 呼び出しに対する応答のサイズが 1 GB 程度になる可能性があります。このサイズの応答を許可しない中継点があるため、要求は失敗します。
-
複雑なフィルターを使用し、数百万個のキュー アイテムを含むキューにページネーションを行うと、数十ページを処理した後に要求がタイムアウトし始める場合があります。これは、データベースから取得する必要があるデータの量が原因です。
Jobs - GetAll endpoint responses. These are the impacted fields:
|
エンドポイント |
省略されたフィールド |
代わりに使用できるもの |
発効日 |
|---|---|---|---|
|
|
|
エクスポートには、次の専用のエンドポイントを使用します。
GET/odata/Jobs/UiPath.Server.Configuration.Data.Export詳しくは、「ジョブをエクスポートする」をご覧ください。 |
Community およびカナリア テナント: 2024 年 3 月 Enterprise テナント: 2024 年 7 月 |
GET /odata/Jobs endpoint, either via API or via the Get Jobs, Get Queue Items, or Orchestrator HTTP Request activities, you need to find out whether you use any of the listed fields. If you do, please be aware that the content of these fields will be returned as null.
カナリア テナントでプロセスをテストして、影響を評価することをお勧めします。
GET/odata/QueueItems endpoint is optimized by applying these size limitations to its fields:
|
フィールド |
上限量 | 発効日 |
How to tell that you are impacted |
How to address this |
|---|---|---|---|---|
Progress |
1,048,576 characters |
> Community and Canary tenants: April 2024 > Enterprise tenants: May 2024 |
A specific error message is returned. |
We recommend that you use storage buckets and/or Data Service blob storage if you need to store more data. |
|
104,857 characters |
All tenants: September 2024 | |||
AnalyticsData |
10 KB |
> Community and Canary tenants: June 2024 > Enterprise tenants: September 2024 |
Enterprise: If your current data load exceeds these limits, we will send monthly reports to administrators. | |
Output |
100 KB | |||
SpecificData |
500 KB | |||
ProcessingException - Reason |
102,400 characters | |||
ProcessingException - Details |
102,400 characters |
The following filter is also limited for performance purposes:
|
フィルター |
上限量 |
発効日 |
How to tell that you are impacted |
How to address this |
|---|---|---|---|---|
|
|
> If you do not use the
$top filter, you receive 100 records by default.
> If you use the
$top filter, you receive a maximum of 100 records. Anything exceeding 100 triggers a 400 Bad Request error message.
|
> Community and Canary tenant: June 2024 > Enterprise tenants: September 2024 |
Enterprise: We aim to send an email notification to administrators if we detect the usage of this filter in API calls. However, we ask that you keep a close eye on your end as well. |
We recommend that you modify your process or API usage logic accordingly if you expect to exceed this limit. |
Jobs and QueueItems fields:
- ジョブおよびキュー アイテムのデータを取得する例については、「ジョブをエクスポートする」および「キュー アイテムをエクスポートする」をご覧ください。
- Insights のリアルタイムのデータ エクスポート オプションを使用します。
- 前述の方法がうまくいかない場合は、アカウントマネージャーまたはサポート チームにご連絡ください。
レート制限と大きなデータ フィールドの変更は、オンプレミス環境では実装されません。
スタンドアロンの Orchestrator を使用しておりクラウドへの移行を検討している場合は、IIS 要求ログを使用して、影響を受けるエンドポイントに対する要求レートを確認できます。分析はログの集計方法によって異なりますが、Microsoft Log Parser などを使用できます。
大きなデータ フィールドへの影響を評価するには、カナリア テナントでプロセスをテストすることをお勧めします。
