Limites de taxa e otimização do uso de campos de dados grandes

Os limites de taxas e otimizações em relação a campos de dados grandes são práticas recomendadas do setor para manter níveis de desempenho ideais, uso altamente seguro e disponibilidade constante do serviço. É assim que eles beneficiam você:

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

Os limites e as otimizações de campos de dados grandes descritos abaixo exigem alguns ajustes de sua parte, mas estamos confiantes de que eles trarão benefícios a longo prazo.

Limites de taxa

Esses são os limites que impomos:

Endpoint	Limits	Em vigor desde	Exemplos
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 Community, Canary e Enterprise: julho 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 Community, Canary e Enterprise: julho 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 solicitações de API/dia/tenant	Community, Canary e Enterprise tenants: outubro de 2024	N/A
POST/odata/QueueDefinitions({key})/UiPathODataSvc.Export	100 solicitações de API/dia/tenant	Community, Canary e Enterprise tenants: outubro de 2024	N/A
POST/odata/RobotLogs/UiPath.Server.Configuration.OData.Export	100 solicitações de API/dia/tenant	Community, Canary e Enterprise tenants: outubro de 2024	N/A
POST/odata/Jobs/UiPath.Server.Configuration.OData.Export	100 solicitações de API/dia/tenant	Community, Canary e Enterprise tenants: outubro de 2024	N/A

¹ 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>) não é de taxa limitada.

Esses limites não se aplicam à adição de itens de fila e trabalhos de processamento. Dessa forma, não há impacto na adição de um item de fila, na remoção dele de uma fila, na configuração do seu status ou na inicialização e processamento de qualquer número de trabalhos.

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

Cabeçalhos expostos

Cabeçalho	Description	Exemplo
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 o limite de taxa no ponto de extremidade expira em 10 segundos. Quaisquer novas tentativas dentro desses 10 segundos resultam em uma resposta 429.
X-RateLimit-Remaining	O número de chamadas restantes	X-RateLimit-Remaining: 30 significa que você tem 30 chamadas restantes no intervalo de tempo atual

Observação:

Se o número de solicitações por minuto estiver abaixo de 10, ele é renderizado como 0.

Impacto das atividades

As seguintes atividades são impactadas por esses limites:

• Get Job
• Get Queue Items
• Orchestrator Http Request (when used to call the GET /odata/Jobs or GET /odata/QueueItems endpoints)

As Atividades do sistema versão 2024.3 ou mais recentes aplicam o cabeçalho de resposta do Retry-after, o que significa que executam novas tentativas automáticas de operações do Orchestrator. Certifique-se de sempre usar a versão mais recente das Atividades do sistema para se beneficiar disso.

Adaptação às alterações

Isso é o que recomendamos que você faça para garantir que você esteja em conformidade com nossos limites e aproveite-os ao máximo:

• Revise seus padrões de uso de API e as informações que você recupera de nossos pontos de extremidade do tipo GetAll mencionados anteriormente.
• Ajuste sua frequência de chamadas de API e procedimentos de extração de dados para se alinhar a esses limites quando necessário.
• 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.
  • Não use esses pontos de extremidade para recuperação de dados em tempo real.
• Make sure you always use the latest version of System activities.
• Entre em contato com seu gerente de conta ou nossa equipe de suporte se você tiver alguma dúvida ou precisar de mais esclarecimentos.

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:
  • É enviado diariamente, no aplicativo e por email.
  • Você está inscrito nele por padrão.
  • Inclui o nome do ponto de extremidade para o qual o número de solicitações foi excedido.
  • 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:
  • É enviado a cada dez minutos, no aplicativo e por email.
  • Sua inscrição está cancelada por padrão.
  • Inclui o nome do ponto de extremidade para o qual o número de solicitações foi excedido.
  • It includes a link to the tenant-level API audit monitoring window, focused on the detailed 10-minute view. Details...
    Observação:

    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.

Cenários de alerta

Você é alertado nos seguintes cenários:

• Quando você excede 100 solicitações/minuto/tenant de API por meio de uso não automatizado.
• Quando você excede 1.000 solicitações/minuto/tenant de API por meio do uso de automação.

Campos de dados grandes

Os pontos de extremidade de API usados para recuperar listas de trabalhos e itens de fila podem ser problemáticos quando usados para monitoramento em tempo real e exportação de dados. Por exemplo:

• Ao solicitar até 1.000 itens, com cada item no valor de até 1 MB de dados grandes, a resposta a uma única chamada de API pode ser de 1 GB. Como há intermediários que não permitem respostas desse tamanho, as solicitações falham.
• Ao usar filtros complexos e, em seguida, paginar uma fila com vários milhões de itens de fila, as solicitações podem começar a esgotar o tempo após algumas dezenas de páginas. Isso se deve à quantidade de dados que precisam ser recuperados do banco de dados.

Campos de trabalhos

Para melhorar a eficiência do sistema e proteger a privacidade dos dados, dados específicos são omitidos das respostas do ponto de extremidade Jobs - GetAll. Esses são os campos impactados:

Endpoint	Campos omitidos	O que você pode usar alternativamente	Em vigor desde
GET/odata/Jobs	InputArguments OutputArguments	GET/odata/Jobs({key})	Tenants Community e Canary: março de 2024 Tenants Enterprise: julho 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.

Recomendamos que você teste processos em seus tenants Canary para avaliar o impacto.

Campos de dados grandes de itens de filas

O desempenho do ponto de extermidad GET/odata/QueueItems é otimizado aplicando essas limitações de tamanho aos campos:

Campo	Limite	Em vigor desde	Como saber se você foi impactado	Como resolver isso
Progress	1.048.576 caracteres	> Tenants Community e Canary: abril de 2024 > Tenants Enterprise: maio de 2024	Uma mensagem de erro específica é retornada se os dados que você está tentando carregar excederem esses limites.	Recomendamos que você use buckets de armazenamento e/ou armazenamento de blob do Data Service se precisar armazenar mais dados.
	104.857 caracteres	Todos os tenants: setembro de 2024
AnalyticsData/Analytics	5.120 caracteres	> Tenants Community e Canary: junho de 2024 > Tenants Enterprise: setembro 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.

O filtro a seguir também é limitado para fins de desempenho:

Filtro	Limite	Em vigor desde	Como saber se você foi impactado	Como resolver isso
$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: pretendemos enviar uma notificação por email aos administradores se detectarmos o uso desse filtro em chamadas de API. No entanto, pedimos que você também fique de olho.	Recomendamos que você modifique adequadamente sua lógica de uso de APIs ou processos se quiser exceder esse limite.

Alternativas

Você pode usar as seguintes alternativas para recuperar os campos Jobs e 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.
• Entre em contato com seu gerente de conta ou nossa equipe de suporte se os métodos anteriores não funcionarem para você.

Mudança de local para a nuvem

Importante:

Os limites de taxa e as alterações de campos de dados grandes não serão implementadas em ambientes locais.

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 avaliar o impacto em campos de dados grandes, recomendamos testar seus processos em tenants Canary.