キーレートリミットプラグインの設定 - API Gateway - Alibaba Cloud ドキュメントセンター

キーレートリミットプラグインは、URL パラメーターまたは HTTP リクエストヘッダーから取得した特定のキーの値に基づいてリクエストをスロットリングします。

プラグインの種類

スロットリングプラグインです。

フィールド

フィールド	データ型	必須	デフォルト値	説明
limit_by_header	文字列	いいえ、`limit_by_header` または `limit_by_param` のいずれかを設定する必要があります。	-	スロットリングのキー値を提供する HTTP リクエストヘッダー。
limit_by_param	文字列	いいえ、`limit_by_header` または `limit_by_param` のいずれかを設定する必要があります。	-	スロットリングのキー値を提供する URL パラメーター。
limit_keys	オブジェクトの配列	はい	-	特定のキー値に対するレート制限ルール。

limit_keys オブジェクトのフィールド：

設定項目	データ型	必須	デフォルト値	説明
key	文字列	はい	-	受信リクエストと照合する値。
query_per_second	数値	いいえ、`query_per_second`、`query_per_minute`、`query_per_hour`、または `query_per_day` のいずれかを設定する必要があります。	-	1 秒あたりの最大リクエスト数。
query_per_minute	数値	いいえ、`query_per_second`、`query_per_minute`、`query_per_hour`、または `query_per_day` のいずれかを設定する必要があります。	-	1 分あたりの最大リクエスト数。
query_per_hour	数値	いいえ、`query_per_second`、`query_per_minute`、`query_per_hour`、または `query_per_day` のいずれかを設定する必要があります。	-	1 時間あたりの最大リクエスト数。
query_per_day	数値	いいえ、`query_per_second`、`query_per_minute`、`query_per_hour`、または `query_per_day` のいずれかを設定する必要があります。	-	1 日あたりの最大リクエスト数。

例

リクエストヘッダー x-ca-key のキー値に基づいてリクエストをスロットリングします。
```
limit_by_header: x-ca-key
limit_keys:
- key: 102234
  query_per_second: 10
- key: 308239
  query_per_hour: 10
```

URL パラメーター 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

特定のルートまたはドメイン名に対してスロットリングを有効にします。

次のプラグイン設定を route-a および route-b ルートに適用します：
```
  limit_by_header: x-ca-key
  limit_keys:
  - key: 102234
    query_per_second: 10
```
次のプラグイン設定を *.example.com および test.com ドメイン名に適用します：
```
  limit_by_header: x-ca-key
  limit_keys:
  - key: 102234
    query_per_second: 100
```
説明
- route-a と route-b は、ゲートウェイルートの作成時に指定されたルートを指します。リクエストがこれらのルートのいずれかに一致する場合、対応するルールが適用されます。
- *.example.com と test.com は、リクエストのドメイン名と照合されます。リクエストがこれらのドメイン名のいずれかに一致する場合、対応するルールが適用されます。
- ルールは設定された順序で評価されます。最初のルールが一致すると、後続のルールは無視されます。