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:

• Garantizan un sistema predecible: conocer el límite de llamadas a la API ayuda a diseñar y mantener mejor tus aplicaciones. Proporciona un entorno predecible, que minimiza las sorpresas debidas a infracciones inesperadas de los límites.
• Mejoran el rendimiento: al controlar el tráfico en nuestros servidores, garantizamos un rendimiento óptimo y respuestas más rápidas, lo que mejora significativamente tu experiencia del producto.
• Mejoran la seguridad: los límites que se describen a continuación actúan como una capa adicional de seguridad, protegiendo tu sistema de posibles ciberamenazas.
• Garantizan un uso justo: nuestros límites de tarifas aseguran una asignación de recursos equitativa a todos los usuarios y un funcionamiento fluido incluso durante los períodos de mayor uso.

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.

Límites de tarifa

Estos son los límites que aplicamos:

PuntoFinal	Ejemplos	Limits	Efectivo desde
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 solicitudes de API/minuto/tenant	Julio de 2024
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 solicitudes de API/minuto/tenant	Julio de 2024

Importante:

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

Es importante tener en cuenta que estos límites no se aplican a la adición de elementos de cola y los 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.

Puedes comprobar tu uso de API por mes o día en la pestaña de auditoría de la API a nivel de tenant en la ventana de Supervisión.

Encabezados expuestos

Encabezado	Descripción	Ejemplo
Retry-After	Todas las solicitudes que superen los límites mencionados reciben una respuesta HTTP 429 que incluye este encabezado. Muestra el número de segundos que debes esperar hasta que el punto final vuelva a estar disponible.	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
• Solicitud Http de Orchestrator (cuando se utiliza para llamar a los puntos finales GET /odata/Jobs o 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.

Adaptarse a los cambios

Esto es lo que te recomendamos que hagas para asegurarte de que cumples nuestros límites y los aprovechas 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.
• Consulta las secciones Exportar trabajos y Exportar elementos en cola para obtener ejemplos sobre cómo recuperar datos de trabajos y elementos en cola.
• Utiliza la opción Exportación de datos en tiempo real de Insights.
• 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.

Large data fields

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 sola 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.

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:

PuntoFinal	Campos omitidos	Qué puedes utilizar en su lugar	Efectivo desde
GET/odata/Jobs	InputArguments OutputArguments	GET/odata/Jobs({key}) Para las exportaciones, utiliza el punto final dedicado: GET/odata/Jobs/UiPath.Server.Configuration.Data.Export Consulta Exportar trabajos para obtener más información.	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.

Queue items large data fields

The performance of the GET/odata/QueueItems endpoint is optimized by applying these size limitations to its fields:

Campo	Límite	Efectivo desde	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:

Filtro	Límite	Efectivo desde	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.

Alternativas

You can use the following alternatives to retrieve Jobs and QueueItems fields:

• Consulta las secciones Exportar trabajos y Exportar elementos en cola para obtener ejemplos sobre cómo recuperar datos de trabajos y elementos en cola.
• Utiliza la opción Exportación de datos en tiempo real de Insights.
• 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.

Si utilizas Orchestrator independiente y estás pensando en mudarte a la nube, puedes utilizar los registros de solicitudes de IIS para determinar la tasa de solicitudes para los puntos finales afectados. El análisis depende de cómo agregues los registros, para lo que puedes utilizar, por ejemplo, Microsoft Log Parser.

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