速率限制

作为行业最佳实践，速率限制可用户保持最佳性能水平、高度安全的使用和恒定的服务可用性。速率限制对您的好处如下：

• 这些限制可确保系统的可预测性：了解 API 调用限制有助于更好地设计和维护应用程序。提供了一个可预测的环境，充分减少了由于意外超出限制而导致的意外情况。
• 提升了性能：通过控制服务器上的流量，我们可确保实现最佳性能和更快的响应，从而显着改善您的产品体验。
• 增强安全性：下面列出的限制可充当额外的安全层，保护您的系统免受潜在的网络威胁。
• 确保合理使用：我们的速率限制可确保将资源公平地分配给所有用户，即使在使用高峰期，也能确保平稳运行。

虽然下面列出的限制需要您进行一些调整，但我们相信它们会带来长期收益。

我们的速率限制

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

Endpoint	Limits	生效时间
GET/odata/Jobs/?<filters>	100 个 API 请求/分钟/租户	2024 年 7 月
GET/odata/QueueItems/?<filters>	100 个 API 请求/分钟/租户	2024 年 7 月

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

您可以在“监控”窗口的租户级别“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 端点时）

适应变化

我们建议您执行以下操作，以确保遵守我们的限制并充分利用这些限制：

• 查看 API 使用模式以及从我们前面提到的 GetAll 类型端点检索的信息。
• 必要时调整 API 调用频率和数据提取程序，以符合这些限制。
• 有关如何检索作业和队列项目数据的示例，请参见导出作业和导出队列项目部分。
• 使用“Insights 实时数据导出”选项。
• 如果您有任何问题或需要进一步说明，请联系您的客户经理或我们的支持团队。

删除大数据字段

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

• 请求最多 1000 个项目且每个项目最多为 1MB 的大数据时，对单个 API 调用的响应大小可以是 1GB。有些中介体不允许这种大小的响应，因此请求将失败。

• 当使用复杂筛选条件，然后对包含数百万个队列项目的队列进行分页时，请求可能会在数十页后开始超时。这是由于需要从数据库检索的数据量较大。

因此，为提高系统效率并保护数据隐私，系统会在 GetAll 端点响应中省略特定数据。受影响的字段如下：

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

如果您通过 API 或者通过“获取作业”、“获取队列项目”或“Orchestrator HTTP 请求”活动使用 GET /odata/Jobs 或 GET /odata/QueueItems 端点，则需要确定是否使用了所列的任何字段。请注意，如果这样做，这些字段的内容将返回为 Null。

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

替代方案

您可以使用以下替代方法来检索字段：

• 有关如何检索作业和队列项目数据的示例，请参见导出作业和导出队列项目部分。
• 使用“Insights 实时数据导出”选项。
• 如果前面的方法不适合您，请联系您的客户经理或我们的支持团队。

从本地部署迁移到云

重要提示：

在本地部署环境中将不会实施速率限制和大型数据字段更改。

如果您使用的是独立版 Orchestrator，并考虑迁移到云，则可以使用 IIS 请求日志来确定受影响端点的请求率。分析取决于您聚合日志的方式，您可以为此使用 Microsoft Log Parser。

为了评估对大数据字段的影响，我们建议在 Canary 租户中测试您的流程。