- Introdução
- Leia-me
- Sobre OData e referências
- URL do Orchestrator
- Referências de API
- Rate limits and large data fields usage optimization
- Recursos lógicos e metadados
- Operações disponíveis
- Tipos enumerados
- Consumindo API de Cloud
- Criação de solicitações de API
- Aplicativos externos (OAuth)
- Permissões por endpoint
- Códigos de resposta
- Definição do Swagger
- Exemplos usando a API do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
Rate limits and large data fields usage optimization
- Eles garantem um sistema previsível: saber o limite de chamada de API ajuda a projetar e manter seus aplicativos. Fornecem um ambiente previsível, minimizando surpresas devido a violações de limite inesperadas.
- Melhoram o desempenho: ao controlar o tráfego em nossos servidores, garantimos o desempenho ideal e respostas mais rápidas, melhorando significativamente sua experiência com o produto.
- Aumentam a segurança: os limites descritos abaixo atuam como uma camada adicional de segurança, protegendo seu sistema contra possíveis ameaças cibernéticas.
- Garantem um uso justo: nossos limites de taxa garantem uma alocação equitativa de recursos para todos os usuários e uma operação tranquila, mesmo durante períodos de pico de 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.
Esses são os limites que impomos:
|
Endpoint |
Exemplos |
Limits |
Em vigor desde |
|---|---|---|---|
|
|
|
100 solicitações de API/minuto/tenant |
Julho de 2024 |
|
|
| 100 solicitações de API/minuto/tenant | Julho de 2024 |
GET/odata/Jobs(<job_id>) is not rate limited.
É importante observar que 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.
Você pode verificar seu uso de API por mês ou por dia na guia Auditoria de API no nível do tenant na janela Monitoramento.
|
Cabeçalho |
Description |
Exemplo |
|---|---|---|
|
|
Todas as solicitações além dos limites mencionados acima recebem uma resposta HTTP 429, que inclui esse cabeçalho. Ela exibe o número de segundos que você precisa esperar até que o ponto de extremidade esteja disponível novamente. |
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.
|
|
|
O número de chamadas restantes |
X-RateLimit-Remaining: 30 significa que você tem 30 chamadas restantes no intervalo de tempo atual
|
Se o número de solicitações por minuto estiver abaixo de 10, ele é renderizado como 0.
As seguintes atividades são impactadas por esses limites:
- Get Job
- Get Queue Items
- Solicitação Http do Orchestrator (quando usada para chamar os pontos de extremidade
GET /odata/JobsouGET /odata/QueueItems)
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.
É isso que recomendamos fazer para garantir que você respeite nossos limites e tire o máximo proveito deles:
- Revise seus padrões de uso de API e as informações que você recupera de nossos pontos de extremidade do tipo
GetAllmencionados 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.
- Consulte as seções Exportação de trabalhos e Exportação de itens de fila para obter exemplos de como recuperar dados de trabalhos e itens de fila.
- Use a opção de Exportação de dados em tempo real do Insights.
- 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.
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.
Jobs - GetAll endpoint responses. These are the impacted fields:
|
Endpoint |
Campos omitidos |
O que você pode usar alternativamente |
Em vigor desde |
|---|---|---|---|
|
|
|
Para exportações, use o ponto de extremidade dedicado:
GET/odata/Jobs/UiPath.Server.Configuration.Data.ExportConsulte Exportação de trabalhos para obter detalhes. |
Tenants Community e Canary: março de 2024 Tenants Enterprise: julho de 2024 |
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.
GET/odata/QueueItems endpoint is optimized by applying these size limitations to its fields:
|
Campo |
Limite | Em vigor 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 |
Limite |
Em vigor desde |
How to tell that you are impacted |
How to address this |
|---|---|---|---|---|
|
|
> 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. |
Jobs and QueueItems fields:
- Consulte as seções Exportação de trabalhos e Exportação de itens de fila para obter exemplos de como recuperar dados de trabalhos e itens de fila.
- Use a opção de Exportação de dados em tempo real do Insights.
- Entre em contato com seu gerente de conta ou nossa equipe de suporte se os métodos anteriores não funcionarem para você.
Os limites de taxa e as alterações de campos de dados grandes não serão implementadas em ambientes locais.
Se você estiver usando o Orchestrator independente e estiver pensando em migrar para a nuvem, você pode usar os logs de solicitação do IIS para determinar a taxa de solicitação para os pontos de extremidade impactados. A análise depende de como você agrega os logs, para os quais você pode usar, por exemplo, o Microsoft Log Parser.
Para avaliar o impacto em campos de dados grandes, recomendamos testar seus processos em tenants Canary.
