Orchestrator

Rate limits and large data fields usage optimization

Rate limits and optimizations around large data fields are industry best practices for maintaining optimal performance levels, highly secure usage, and constant service availability. This is how they benefit you:

这些限制可确保系统的可预测性：了解 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.

速率限制

以下是我们强制执行的限制：

Endpoint	示例	Limits	生效时间
`GET/odata/Jobs/?<filters>`	`GET/odata/Jobs` `GET/odata/Jobs?$top=100` `GET/odata/Jobs?$top=20&$filter=Robot/Id eq 123L` `GET/odata/Jobs?$filter=((CreationTime ge 2024-04-04T12:00:47.264Z) and (ProcessType eq 'Process'))&$expand=Robot,Machine,Release&$orderby=CreationTime desc`	100 个 API 请求/分钟/租户	2024 年 7 月
`GET/odata/QueueItems/?<filters>`	`GET/odata/QueueItems` `GET/odata/QueueItems/?$top=20` `GET/odata/QueueItems?$filter=((Status eq '0'))` `GET/odata/QueueItems?$filter=((QueueDefinitionId eq 102135))&$expand=Robot,ReviewerUser&$orderby=Id desc`	100 个 API 请求/分钟/租户	2024 年 7 月

重要提示：

GET/odata/Jobs(<job_id>) is not rate limited.

需要注意的是，这些限制不适用于添加队列项目和处理作业。因此，添加队列项目、从队列中删除项目、设置其状态或启动和处理任意数量的作业都不会受到影响。

您可以在“监控”窗口的租户级别“API 审核”选项卡中查看每月或每天的 API 使用情况。

公开标头

页眉	描述	示例
`Retry-After`	系统将向所有超出上述限制的请求返回包含此标头的 HTTP 429 响应。它会显示端点再次可用之前需要等待的秒数。	`Retry-After: 10` 表示端点上的速率限制将在 10 秒后过期。在这 10 秒内进行任何重试都会导致 429 响应。
`X-RateLimit-Remaining`	剩余调用次数	`X-RateLimit-Remaining: 30` 表示您在当前时间范围内还剩 30 次调用

备注：

如果每分钟的请求数低于 10，则呈现为 0。

活动影响

以下活动受这些限制的影响：

获取作业
获取队列项目
Orchestrator Http 请求（当用于调用 GET /odata/Jobs 或 GET /odata/QueueItems 端点时）

System activities version 2024.3 or newer apply the 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.
如果您有任何问题或需要进一步说明，请联系您的客户经理或我们的支持团队。

Large data fields

用于检索作业和队列项目列表的 API 端点在用于实时监控和数据导出时可能会出现问题。例如：

请求最多 1000 个项目且每个项目最多为 1MB 的大数据时，对单个 API 调用的响应大小可以是 1GB。有些中介体不允许这种大小的响应，因此请求将失败。
当使用复杂筛选条件，然后对包含数百万个队列项目的队列进行分页时，请求可能会在数十页后开始超时。这是由于需要从数据库检索的数据量较大。

Jobs fields

To improve system efficiency and safeguard data privacy, specific data is omitted from the Jobs - GetAll endpoint responses. These are the impacted fields:

Endpoint	省略的字段	可使用的替代方案	生效时间
`GET/odata/Jobs`	`InputArguments` `OutputArguments`	`GET/odata/Jobs({key})` 对于导出，请使用专用端点： `GET/odata/Jobs/UiPath.Server.Configuration.Data.Export` 有关详细信息，请参见导出作业。	社区版和 Canary 租户：2024 年 3 月企业版租户：2024 年 7 月

If you are using the 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.

我们建议您在 Canary 租户中测试流程，以评估影响。

Queue items large data fields

The performance of the 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.
`Progress`	104,857 characters	All tenants: September 2024	A specific error message is returned.
`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
`$top`	> 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.