Como configurar o interceptor de Rate Limit?
|
Esse interceptor só pode ser inserido no fluxo de requisição. A seção Flows pode ser configurada ao criar ou editar uma API ou Plano:
1. Na API:
-
Acesse API Design > API Catalog e encontre a sua API;
-
Na seção Flows, clique em Edit;
-
Clique e arraste o interceptor Rate Limit para o flow. Ao fazer isso, uma janela com as propriedades de configuração abrirá.
-
Escolha o tipo de configuração entre Total Calls, IP e Header;
-
Ao escolher Total Calls, você limita as requisições pelo número de chamadas, independente da origem.
-
Ao escolher IP, você limita as requisições por IP. Isso quer dizer que cada IP poderá acessar pelo número de vezes que você configurou.
-
Ao escolher Header você configura um header específico para a restrição de tráfego. Ao selecionar essa opção, você deve informar:
-
Key: a chave do header desejado.
-
Missing header behavior: configura o comportamento para requisições sem o header. Escolha entre:
-
Allow: ignora o processamento do interceptor, permitindo o fluxo da requisição.
-
Total Calls: trata a requisição com base no número total de chamadas.
-
Abort: bloqueia a requisição.
-
-
-
-
Informe o número máximo de chamadas no campo Calls;
-
Em Interval, selecione o período de limite das chamadas entre Second, Minute, Hour, Day ou Month;
-
Se quiser adicionar um percentual de chamadas acima do limite permitido, marque a opção Soft Limit e informe o valor do campo %;
-
Se quiser adicionar um parâmetro para receber a quantidade de requisições restantes no header da resposta, marque a opção Return quota header;
-
Clique Save.
Se preferir, siga os passos acompanhando o vídeo:
2. No Plano
-
Acesse API Design > Plans e encontre o seu plano;
-
Clique em Edit;
-
Na seção Flows, clique e arraste o interceptor Rate Limit para o flow. Ao fazer isso, uma janela com as propriedades de configuração abrirá.
-
Escolha o tipo de configuração entre Total Calls, IP e Header;
-
Ao escolher Total Calls, você limita as requisições pelo número de chamadas, independente da origem.
-
Ao escolher IP, você limita as requisições por IP. Isso quer dizer que cada IP poderá acessar pelo número de vezes que você configurou.
-
Ao escolher Header você configura um header específico para a restrição de tráfego. Ao selecionar essa opção, você deve informar:
-
Key: a chave do header desejado.
-
Missing header behavior: configura o comportamento para requisições sem o header. Escolha entre:
-
Allow: ignora o processamento do interceptor, permitindo o fluxo da requisição.
-
Total Calls: trata a requisição com base no número total de chamadas.
-
Abort: bloqueia a requisição.
-
-
-
-
Informe o número máximo de chamadas no campo Calls;
-
Em Interval, selecione o período de limite das chamadas entre Second, Minute, Hour, Day ou Month;
-
Se quiser adicionar um percentual de chamadas acima do limite permitido, marque a opção Soft Limit e informe o valor do campo %;
-
Se quiser adicionar um parâmetro para receber a quantidade de requisições restantes no header da resposta, marque a opção Return quota header;
-
Clique Save.
Share your suggestions with us!
Click here and then [+ Submit idea]