Límites de tasa y optimización del uso de grandes campos de datos

Los límites de tarifa y las optimizaciones en torno a grandes campos de datos son las mejores prácticas de la industria para mantener niveles de rendimiento óptimos, un uso altamente seguro y una disponibilidad constante del servicio. Así es como te benefician:

• They ensure a predictable system: knowing the API call limit helps in better designing and maintaining your applications. It provides a predictable environment, minimizing surprises due to unexpected limit breaches.
• They improve performance: by controlling the traffic on our servers, we ensure optimal performance and quicker responses, significantly improving your product experience.
• They enhance security: the limits outlined below act as an additional layer of security, protecting your system from potential cyber threats.
• They ensure fair usage: our rate limits assure equitable resource allocation to all users, and smooth operation even during peak use periods.

Los límites y las grandes optimizaciones de campos de datos que se describen a continuación requieren algunos ajustes por su parte, pero estamos seguros de que aportarán beneficios a largo plazo.

Límites de tarifa

Estos son los límites que aplicamos:

PuntoFinal	Limits	Efectivo desde	Ejemplos
GET/odata/Jobs/?<filters>	100 API requests/minute/tenant for non-automation usage 1 1,000 API requests/minute/tenant for automation usage 2	Tenants de Community, Canary y Enterprise: julio de 2024	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
GET/odata/QueueItems/?<filters>	100 API requests/minute/tenant for non-automation usage 1 1,000 API requests/minute/tenant for automation usage 2	Tenants de Community, Canary y Enterprise: julio de 2024	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
POST/odata/AuditLogs/UiPath.Server.Configuration.OData.Export	100 solicitudes de API/día/inquilino	Tenants de Community, Canary y Enterprise: octubre de 2024	N/D
POST/odata/QueueDefinitions({key})/UiPathODataSvc.Export	100 solicitudes de API/día/inquilino	Tenants de Community, Canary y Enterprise: octubre de 2024	N/D
POST/odata/RobotLogs/UiPath.Server.Configuration.OData.Export	100 solicitudes de API/día/inquilino	Tenants de Community, Canary y Enterprise: octubre de 2024	N/D
POST/odata/Jobs/UiPath.Server.Configuration.OData.Export	100 solicitudes de API/día/inquilino	Tenants de Community, Canary y Enterprise: octubre de 2024	N/D

¹ Non-automation usage refers to API calls originating from API integrations outside of processes, such as PowerShell scripts and third party monitoring tools.

² Automation usage refers to API calls originating from Get Queue Items, Get Jobs, and Orchestrator Http Request activities.

Importante:

GET/odata/Jobs(<job_id>) no está limitado por tasa.

Estos límites no se aplican a la adición de artículos en cola y trabajos de procesamiento. Como tal, no hay impacto en la adición de un elemento de cola, la eliminación de una cola, la configuración de su estado o el inicio y el procesamiento de cualquier número de trabajos.

You can check your API usage per month or day on the tenant-level API audit tab in the Monitoring window.

Encabezados expuestos

Encabezado	Descripción	Ejemplo
Retry-After	All requests beyond the aforementioned limits are returned an HTTP 429 response which includes this header. It displays the number of seconds that you need to wait until the endpoint is available to you again.	Retry-After: 10 significa que el límite de velocidad en el punto final caduca en 10 segundos. Cualquier reintento en estos 10 segundos da como resultado una respuesta 429.
X-RateLimit-Remaining	El número de llamadas restantes	X-RateLimit-Remaining: 30 significa que te quedan 30 llamadas en el intervalo de tiempo actual

Nota:

Si el número de solicitudes por minuto es inferior a 10, se representa como 0.

Impacto de las actividades

Las siguientes actividades se ven afectadas por estos límites:

• Obtener trabajo
• Obtener elementos de la cola
• Orchestrator Http Request (when used to call the GET /odata/Jobs or GET /odata/QueueItems endpoints)

Las actividades del sistema versión 2024.3 o posteriores aplican el encabezado de respuesta Retry-after, lo que significa que realizan reintentos automáticos de las operaciones de Orchestrator. Asegúrese de utilizar siempre la última versión de las actividades del sistema para beneficiarse de esto.

Adaptarse a los cambios

Esto es lo que te recomendamos hacer para asegurarte de que cumples con nuestros límites y aprovecharlos al máximo:

• Revisa tus patrones de uso de API y la información que recuperas de nuestros puntos finales de tipo GetAll mencionados anteriormente.
• Ajusta la frecuencia de llamadas a la API y los procedimientos de extracción de datos para ajustarlos con estos límites cuando sea necesario.
• Use the Insights real-time data export option for real-time exports.
• See the Exporting jobs and Exporting queue items sections for examples on how to retrieve jobs and queue items data for reporting and archiving purposes only.
  Importante:

  • These endpoints are limited to 100 API requests/day/tenant. Once that limit is exceeded, a #4502 error will be displayed, stating that the daily limit per tenant has been reached. The limit resets at 00:00 UTC.
  • No utilices estos endpoints para la recuperación de datos en tiempo real.
• Make sure you always use the latest version of System activities.
• Ponte en contacto con tu gestor de cuentas o con nuestro equipo de soporte si tienes alguna pregunta o necesitas más aclaraciones.

Alertas

These alerts, available in the API Rate Limits section of your alerting settings, inform you when the limits are exceeded, and provide valuable information about the impacted endpoint.

• Request rate exceeded the limit in the last day - Warn severity:
  • Se envía diariamente, en la aplicación y por correo electrónico.
  • Estás suscrito a ella de forma predeterminada.
  • Incluye el nombre del punto final para el que se ha superado el número de solicitudes.
  • It includes a link to the tenant-level API audit monitoring window, focused on the daily view. Details...
  • It requires the Audit - View permission.
• Request rate exceeded the limit - Error severity:
  • Se envía cada diez minutos, en la aplicación y por correo electrónico.
  • Se te ha cancelado la suscripción de forma predeterminada.
  • Incluye el nombre del punto final para el que se ha superado el número de solicitudes.
  • It includes a link to the tenant-level API audit monitoring window, focused on the detailed 10-minute view. Details...
    Nota:

    There might be a 10-minute delay between the moment that the limit is exceeded and the time the alert is sent.

  • It requires the Audit - View permission.

Escenarios de alerta

Se te alerta en los siguientes escenarios:

• Cuando superas las 100 solicitudes de API/minuto/tenant mediante uso no automatizado.
• Cuando superas las 1000 solicitudes de API/minuto/tenant mediante el uso de automatización.

Campos de datos grandes

Los puntos finales de la API utilizados para recuperar listas de trabajos y elementos de cola pueden resultar problemáticos cuando se utilizan para la supervisión en tiempo real y la exportación de datos. Por ejemplo:

• Al solicitar hasta 1000 elementos, con cada elemento que asciende a hasta 1 MB de datos grandes, la respuesta a una única llamada a la API puede ser de 1 GB de tamaño. Dado que hay intermediarios que no permiten respuestas de este tamaño, las solicitudes fallan.
• Al utilizar filtros complejos y luego paginar una cola con varios millones de elementos de cola, las solicitudes pueden comenzar a agotarse después de unas pocas docenas de páginas. Esto se debe a la cantidad de datos que deben recuperarse de la base de datos.

Campos de trabajos

Para mejorar la eficiencia del sistema y salvaguardar la privacidad de los datos, se omiten datos específicos de las respuestas del punto final Jobs - GetAll. Estos son los campos afectados:

PuntoFinal	Campos omitidos	Qué puedes utilizar en su lugar	Efectivo desde
GET/odata/Jobs	InputArguments OutputArguments	GET/odata/Jobs({key})	Tenants de comunidad y canarios: marzo de 2024 Tenants de Enterprise: julio de 2024

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.

Te recomendamos que pruebes los procesos en tus tenants canarios para evaluar el impacto.

Grandes campos de datos de los artículos en cola

El rendimiento del punto final GET/odata/QueueItems se optimiza aplicando estas limitaciones de tamaño a sus campos:

Campo	Límite	Efectivo desde	Cómo saber que se ha visto afectado	Cómo abordar esto
Progress	1 048 576 caracteres	> Tenants de comunidad y canarios: abril de 2024 > Tenants de Enterprise: mayo de 2024	Se devuelve un mensaje de error específico si los datos que intentas cargar superan estos límites.	Le recomendamos que utilice depósitos de almacenamiento y/o el almacenamiento de blob de Data Service si necesita almacenar más datos.
	104 857 caracteres	Todos los tenants: septiembre de 2024
AnalyticsData/Analytics	5.120 caracteres	> Tenants de comunidad y canarios: junio de 2024 > Tenants de Enterprise: septiembre de 2024
OutputData/Output	51.200 caracteres
SpecificContent/SpecificData	256.000 caracteres
ProcessingException - Reason	102 400 caracteres
ProcessingException - Details	102 400 caracteres

Importante:

These limits are calculated based on the UTF-16 encoding style, which is mainly used by SQL Server to store data. Information is stored in SQL Server via data types like NVARCHAR. In these data types, each character, including widely used characters from languages like Chinese, Japanese, and Korean, is stored using 2 bytes. This may be misleading when you check the data payload using Notepad or in UTF-8, since these display 1 byte per character (primarily ASCII 0-127 abc123 etc). For instance, if you were to store a Chinese character like 文 in a text file with UTF-8 encoding, it would be stored as a 3-byte sequence (E6 96 87), thus consuming more storage space. The difference between encoding styles makes the number of characters unreliable as a limit.

El siguiente filtro también está limitado por motivos de rendimiento:

Filtro	Límite	Efectivo desde	Cómo saber que se ha visto afectado	Cómo abordar esto
$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	Empresa: nuestro objetivo es enviar una notificación por correo electrónico a los administradores si detectamos el uso de este filtro en las llamadas a la API. Sin embargo, le pedimos que también vigile de cerca su final.	Le recomendamos que modifique su proceso o la lógica de uso de API en consecuencia si espera superar este límite.

Alternativas

Puede utilizar las siguientes alternativas para recuperar los campos Jobs y QueueItems:

• See the Exporting jobs and Exporting queue items sections for examples on how to retrieve jobs and queue items data.
• Use the Insights real-time data export option.
• Ponte en contacto con tu gestor de cuentas o nuestro equipo de soporte si los métodos anteriores no te funcionan.

Mover de las instalaciones a la nube

Importante:

Los límites de tarifa y los grandes cambios en los campos de datos no se implementarán en los entornos locales.

If you are using standalone Orchestrator and are thinking of moving to cloud, you can use the IIS request logs to determine the request rate for the impacted endpoints. The analysis depends on how you aggregate the logs, for which you can use, for instance, Microsoft Log Parser.

Para evaluar el impacto en grandes campos de datos, recomendamos probar tus procesos en los tenants canarios.