Todos os produtos
Search
Central de documentação

API Gateway:key-rate-limit

Última atualização: Jun 27, 2026

O plug-in key-rate-limit limita requisições com base em valores de chave específicos obtidos de parâmetros de URL ou cabeçalhos de requisição HTTP.

Tipo de plug-in

Plug-in de limitação de taxa.

Campos

Campo

Tipo de dados

Obrigatório

Valor padrão

Descrição

limit_by_header

string

Não. Configure limit_by_header ou limit_by_param.

-

Cabeçalho de requisição HTTP que fornece o valor da chave de limitação.

limit_by_param

string

Não. Configure limit_by_header ou limit_by_param.

-

Parâmetro de URL que fornece o valor da chave de limitação.

limit_keys

array de objetos

Sim

-

Regras de limitação de taxa para valores de chave específicos.

Campos no objeto limit_keys:

Item de configuração

Tipo de dados

Obrigatório

Valor padrão

Descrição

key

string

Sim

-

Valor a ser comparado com as requisições recebidas.

query_per_second

number

Não. Configure query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Número máximo de requisições permitidas por segundo.

query_per_minute

number

Não. Configure query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Número máximo de requisições permitidas por minuto.

query_per_hour

number

Não. Configure query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Número máximo de requisições permitidas por hora.

query_per_day

number

Não. Configure query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Número máximo de requisições permitidas por dia.

Exemplos

  • Limite requisições pelo valor da chave do cabeçalho de requisição x-ca-key.

    limit_by_header: x-ca-key
    limit_keys:
    - key: 102234
      query_per_second: 10
    - key: 308239
      query_per_hour: 10
  • Limite requisições pelo valor da chave do parâmetro de requisição apikey.

    limit_by_param: apikey
    limit_keys:
    - key: 9a342114-ba8a-11ec-b1bf-00163e1250b5
      query_per_second: 10
    - key: a6a6d7f2-ba8a-11ec-bec2-00163e1250b5
      query_per_minute: 100
  • Ative a limitação de taxa para rotas ou nomes de domínio específicos.

    Aplique as seguintes configurações de plug-in às rotas route-a e route-b:

      limit_by_header: x-ca-key
      limit_keys:
      - key: 102234
        query_per_second: 10

    Aplique a seguinte configuração de plug-in aos nomes de domínio *.example.com e test.com:

      limit_by_header: x-ca-key
      limit_keys:
      - key: 102234
        query_per_second: 100
    Nota
    • route-a e route-b referem-se às rotas especificadas durante a criação de rotas do gateway. Se uma requisição corresponder a uma dessas rotas, as regras correspondentes entrarão em vigor.

    • *.example.com e test.com correspondem aos nomes de domínio das requisições. Caso uma requisição corresponda a um desses domínios, as regras associadas serão aplicadas.

    • As regras são aplicadas em sequência. Se a primeira regra for correspondida, as subsequentes serão ignoradas.