Criar um limite de taxa de API REST de entrada

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • Crie regras de limite de taxa para limitar o número de solicitações de REST API de entrada processadas por hora.

    Antes de Iniciar

    Função necessária: rate_limit_admin

    Por Que e Quando Desempenhar Esta Tarefa

    Defina limites de taxa para todos os usuários, usuários com funções específicas ou todos os usuários.
    Nota:
    Conforme as solicitações atingem uma instância, cada nó mantém uma contagem de limite de taxa por usuário. A cada 30 segundos, a contagem é confirmada no banco de dados. Como resultado, uma regra de limite de taxa pode não ter efeito por até 30 segundos.

    Procedimento

    1. Navegar até Todos > Serviços web do sistema > REST > Regras de Limite de Taxa.
    2. Clique em Novo e insira os seguintes valores de campo.
      Tabela 1. Formulário Regra de limite de taxa da REST API
      Campo Descrição
      Recurso de API REST Valor derivado dos valores inseridos nos campos a seguir.
      Nome Nome exclusivo para a regra de limite de taxa.
      REST API API REST selecionada na lista de todas as REST APIs externas da instância.
      Versão Versão da REST API. Os valores listados dependem da REST API selecionada.
      Recurso Recurso para a versão. Os valores listados dependem da versão selecionada.
      Tabela Tabela que você deseja direcionar. Aparece somente quando você seleciona a API de tabela como a REST API.
      Tabela do conjunto de importação Tabela do conjunto de importação que você deseja direcionar. Aparece somente se você selecionar a API de conjunto de importação como a REST API.
      Ativo Marque a caixa para indicar que a regra de limite de taxa está ativa.

      As regras de limite de taxa são ativadas por padrão assim que são criadas. Você pode desativar as regras de limite de taxa para interromper a aplicação de um limite de taxa ou para ativar regras de limite de taxa para retomar a aplicação de um limite de taxa.

      Limite de solicitação por hora Número máximo de solicitações permitidas por hora.
      Nota:
      Sempre que você atualiza o valor deste campo, o Now Platform redefine a contagem de solicitações para 0 e exclui todas as violações da hora atual.
      Aplicar a Usuários restritos por esta regra:
      • O usuário único aplica o limite de taxa a um usuário específico.
      • Usuários com função aplicam o limite de taxa a todos os usuários com uma função específica.
      • Todos os usuários aplicam o limite de taxa a todos os usuários.
      Função Função à qual o limite de taxa se aplica. Aparece somente quando você seleciona Usuários com função no campo Aplicar a.
      Usuário Usuário ao qual o limite de taxa se aplica. Aparece somente quando você seleciona Usuário único no campo Aplicar a.
    3. Clique em Enviar.
      O novo limite de taxa entra em vigor.

    O que Fazer Depois

    Depois de enviar a regra, o Now Platform adiciona as seguintes listas relacionadas ao registro da regra:
    Contagens de limites de taxas
    Lista, por usuário, o número de solicitações de REST API de entrada afetadas por esta regra de limite de taxa.
    Violações de Limite de Taxa
    Lista, por usuário, as violações desta regra de limite de taxa.

    Você pode usar essas listas relacionadas para Monitorar contagens e violações de limite de taxa da REST API de entrada.