Tous les produits
Search
Centre de documentation

API Gateway:Key-rate-limit

Dernière mise à jour :Sep 19, 2026

Le plug-in key-rate-limit limite le débit des requêtes en fonction de valeurs de clé spécifiques extraites des paramètres d'URL ou des en-têtes de requête HTTP.

Type de plug-in

Plug-in de limitation de débit.

Champs

Champ

Type de données

Obligatoire

Valeur par défaut

Description

limit_by_header

string

Non. Vous devez configurer limit_by_header ou limit_by_param.

-

L'en-tête de requête HTTP fournissant la valeur de clé pour la limitation de débit.

limit_by_param

string

Non. Vous devez configurer limit_by_header ou limit_by_param.

-

Le paramètre d'URL fournissant la valeur de clé pour la limitation de débit.

limit_keys

array of object

Oui

-

Les règles de limitation de débit pour des valeurs de clé spécifiques.

Champs de l'objet limit_keys :

Élément de configuration

Type de données

Obligatoire

Valeur par défaut

Description

key

string

Oui

-

La valeur à faire correspondre aux requêtes entrantes.

query_per_second

number

Non. Vous devez configurer query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Le nombre maximal de requêtes autorisées par seconde.

query_per_minute

number

Non. Vous devez configurer query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Le nombre maximal de requêtes autorisées par minute.

query_per_hour

number

Non. Vous devez configurer query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Le nombre maximal de requêtes autorisées par heure.

query_per_day

number

Non. Vous devez configurer query_per_second, query_per_minute, query_per_hour ou query_per_day.

-

Le nombre maximal de requêtes autorisées par jour.

Exemples

  • Limitez le débit des requêtes selon la valeur de clé extraite de l'en-tête de requête x-ca-key.

    limit_by_header: x-ca-key
    limit_keys:
    - key: 102234
      query_per_second: 10
    - key: 308239
      query_per_hour: 10
  • Limitez le débit des requêtes selon la valeur de clé extraite du paramètre de requête 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
  • Activez la limitation de débit pour des routes ou des noms de domaine spécifiques.

    Appliquez les configurations de plug-in suivantes aux routes route-a et route-b :

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

    Appliquez la configuration de plug-in suivante aux noms de domaine *.example.com et test.com :

      limit_by_header: x-ca-key
      limit_keys:
      - key: 102234
        query_per_second: 100
    Remarque
    • route-a et route-b désignent les routes spécifiées lors de la création des routes de passerelle. Si une requête correspond à l'une de ces routes, les règles associées s'appliquent.

    • *.example.com et test.com correspondent aux noms de domaine des requêtes. Si une requête correspond à l'un de ces domaines, les règles associées s'appliquent.

    • Les règles s'appliquent dans l'ordre. Si la première règle correspond, les règles suivantes sont ignorées.