---
schema_version: "1"
id: c3f218fab3990076b57c0fc9c6fbf39ebb4fca6feecb2f2c701cbb2a31fe463c
title: レート制限ポリシー
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/mule-gateway/policies-included-rate-limiting.md
canonical_url: https://docs.mulesoft.com/jp/mule-gateway/policies-included-rate-limiting
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 812bef8a57d0c0f459622e995ff81a40a3553e2ee32e767b226be088f04c7789
description: MuleSoft Documentation Site
latest: true
---
# レート制限ポリシー

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><strong>ポリシー名</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>レート制限</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><strong>概要</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>一定期間に処理される要求の最大数を定義することで、API へのアクセスを監視します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><strong>カテゴリ</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>サービス品質</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><strong>使用可能な最小 Mule バージョン</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>v4.1.0</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-right valign-middle" rowspan="4"><p class="tableblock"><strong>返される状況コード</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>400 - SOAP v1.2 を使用する WSDL API によってクォータを超過しました (Mule のみ)。現在のウィンドウの処理が完了するまで要求はブロックされます。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>429 - クォータを超過しました。現在のウィンドウが完了するまで要求はブロックされます。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>500 - SOAP v1.1 を使用する WSDL API によってクォータを超過しました (Mule のみ)。現在のウィンドウの処理が完了するまで要求はブロックされます。</p>
</div></div></td>
</tr>
</tbody>
</table>

## [](#概要)概要

レート制限ポリシーにより、API が特定の期間中に受け取ることができる要求数を制限することで、API への受信トラフィックを制御できます。この制限に達すると、ポリシーはすべての要求を拒否して、バックエンド API の負荷増大を回避します。

レート制限ポリシーを設定するときには、クォータ (要求数) と時間ウィンドウ (期間) の値を自由に組み合わせて指定できます。

## [](#ポリシーのパラメーターの設定)ポリシーのパラメーターの設定

### [](#mule-ゲートウェイ)Mule ゲートウェイ

UI からレート制限ポリシーを API に適用する場合は、次のパラメーターを設定できます。

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">パラメーター</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">例</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Identifier (識別子)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>DataWeave または正規文字列を使用したセレクターキー</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>#[attributes.method]</code>​ は、HTTP で使用できるメソッドごとに異なるグループを作成します。たとえば、ポリシーレート制限の GET 要求のグループを POST 要求とは別に作成します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number of Reqs (要求の数)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ウィンドウで使用可能なクォータ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>正の数</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Time Period (期間)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クォータが適用される時間</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>正の数</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Time Unit (時間単位)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>時間の単位 (ミリ秒、秒、分、時)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Minutes (分)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Distributed (分散)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>このフラグを有効にして相互接続されたランタイムを使用する場合、クォータはすべてのノード間で共有されます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>オンまたはオフ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Expose Headers (ヘッダーを公開)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>応答の一部として ​<a href="#response-header">x-ratelimit ヘッダー</a>​を公開するかどうかを定義するオプション</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>オンまたはオフ</p>
</div></div></td>
</tr>
</tbody>
</table>

## [](#ポリシーのしくみ)ポリシーのしくみ

レート制限ポリシーは、現在のウィンドウ (使用可能なクォータ) 内で要求数を監視し、使用可能なクォータが 0 より大きい場合にのみ、要求がバックエンドに到達できるようにします。

ポリシー設定で識別子を使用することで、複数の要求グループに対してポリシーを設定できます。各グループは、それぞれのウィンドウで別々の使用可能なクォータを持ちます。

レート制限ポリシーの仕組みをわかりやすくするため、10 秒ごとに 3 件の要求という設定で、ウィンドウ内のクォータに基づいて受信要求が許可または拒否される例を見てみましょう。

![2 つの時間枠での受け入れられた要求と拒否された要求のタイムライン](/mulesoft/current/ja-jp/mule-gateway/_images/rate-limiting-generic-example.png)

最初のウィンドウでは、3 番目の要求でクォータに達したため、以降の要求はウィンドウが終了するまで拒否されます。2 番目のウィンドウでは、3 件の要求のうち 2 件しか処理されていないため、ウィンドウが終了しても、残りのクォータは少なくなります。

受け入れられた要求は API を経由してバックエンドに送られます。一方、拒否された要求は 429 の HTTP 状況コード (API が WSDL であれば 400 または 500) を返してバックエンドには到達しません。

一方、拒否された要求は 429 の HTTP 状況コード (API が WSDL であれば 400 または 500) を返してバックエンドには到達しません。

## [](#例)例

上記の 10 秒ごとに 3 件の要求という設定で、レート制限ポリシーがクラスター用に設定され、識別子を使用する場合を考えてみましょう。

### [](#正規文字列を使用した識別子の設定)正規文字列を使用した識別子の設定

UI を使用してポリシー設定に識別子を追加することで、要求のグループを定義できます。設定された制限は、各グループに別々に適用されます。レート制限ポリシー設定では、HTTP メソッドごとに 1 つのバケットに対して識別子 ​`#[attributes.method]`​ を使用できます。

UI の ​`Identifier`​ は非必須パラメーターです。デフォルトでは ​`Identifier`​ は値を持ちません。デフォルトを使用するか、または値を指定するかにより、ポリシーは次のように機能します。

- 未設定 (デフォルト)
    
    レート制限は、バケットまたはグループごとにすべての要求に適用されます。
- 必須 HTTP ヘッダーを使用するように設定
    
    各ヘッダーには個別のクォータが割り当てられます。ヘッダー値では大文字と小文字が区別されます。クォータは​_遅延作成_​を使用して作成されます。
- 非必須 HTTP ヘッダーを使用するように設定
    
    カスタムヘッダー、ペイロード、クエリパラメーター、または式の値には、個別のクォータが割り当てられます。
    
    識別子が要求で送信されない場合、デフォルトで空の値に設定され、独自のクォータが使用されます。この動作では、未制御のクライアントによってコンシュームされる API にレート制限ポリシーを適用できると同時に、識別子を送信するクライアントの特別なバケットに対応します。

次の例は、10 秒おきに 3 つの要求の設定で識別子 ​`#[attributes.method]`​ を使用した場合に、一定期間に発生するイベントの順序を示しています。

![経時的な GET 要求と POST 要求の受け入れと拒否を示す折れ線チャート](/mulesoft/current/ja-jp/mule-gateway/_images/rate-limiting-configure-identifiers-example.png)

この例では、次のようになります。

- すべての HTTP メソッドでは 10 秒おきに 3 つの要求が許可されます (この例では、API に対して GET 要求と POST 要求のみが実行されています)。
- レート制限ポリシーは、固定されたウィンドウで機能します。
    
    詳細は、図中のウィンドウサイズの括弧を参照してください。
- ウィンドウの開始時間は独立しています。
- エンジンはメソッドの最初の要求を受信するとレート制限アルゴリズムをスプールする​_遅延作成_​戦略を使用します。

### [](#dataweave-式を使用した識別子の設定)DataWeave 式を使用した識別子の設定

レート制限エンジンは HTTP に依存せず、DataWeave 式の解決のみに左右されます。複雑なレート制限シナリオに対応するために UI の ​`Identifier`​ 式を変更することができます。

たとえば、すべてのクラス A およびクラス C の LAN 要求に 1 つのバケット、それ以外の要求に別のバケットを使用する識別子をレート制限ポリシーに設定できます。次の画像は前の文の 2 つ目のバケットを示し、DataWeave 式 ​`#[attributes.queryParam[‘customIdentifier’]]`​ をポリシー識別子として使用する 10 秒ごとに 3 件のクォータに相当します。

![時間間隔で整理された受け入れられた要求と拒否された要求の両方を示すタイムライン](/mulesoft/current/ja-jp/mule-gateway/_images/rate-limiting-configure-identifiers-dataweave.png)

この例では、次のようになります。

- 識別子のない要求はすべて空の識別子に解決されます。したがって、1 つのレート制限アルゴリズムを使用します。
- 識別子ごとに異なるバケットが使用され、各バケットには独立したクォータが割り当てられます。

この設定では、要求を実行した IP の地域に対応する false または true のバケットが作成されます。​`false`​ 値と ​`true`​ 値は、HTTP ではなくブール値のドメインに対応します。

いずれにせよ、エンジンは解決された式を文字列として扱うため、ポリシーは正常に機能します。この場合、値は自動的にブールから文字列にキャストされます。スクリプトに ​`output text/plain ---`​ を追加することで、DataWeave でキャストを明示的に定義できます。

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>HTTP RFC のヘッダー名では、大文字と小文字は区別されません。MuleSoft HTTP 用 Anypoint Connector は、ヘッダー名を小文字に変換します。ただし、DataWeave キーでは大文字と小文字が区別されます。したがって、​<code>Identifier</code>​ 式を作成するときには、小文字のヘッダーを参照するようにしてください。</p>
</div>
</td>
</tr>
</tbody></table>

### [](#無制限の識別子セットの設定)無制限の識別子セットの設定

すべての識別子結果では 1 つのアルゴリズムが使用されます。DataWeave 式が無制限の (非常に大規模な) 共用ドメインを返さないように注意して作成してください。このようなドメインが返されると、同じ数のアルゴリズムをメモリ内でホストしなければならなくなります (アルゴリズムが​_遅延作成_​戦略で作成されるため、可能なすべての識別子に対して最低 1 つの要求を実行する必要があります)。

たとえば、DataWeave 式で、インターネットに公開された Mule Runtime Engine での識別子として IP アドレスを使用するとします。インターネット上のすべての公開 IPv4 IP がこの Mule インスタンスに対して要求を実行すると、1 つの Mule インスタンスで 3,706,452,992 件のアルゴリズムが実行されます。

アルゴリズムの平均サイズが 250 バイトであれば、レート制限アルゴリズムのサイズは約 1 テラバイトになります。そのため、有限数の識別子に解決される DataWeave 式を使用することで、結果のセットをできるだけ小さくしてください。

### [](#クラスター用のポリシーの設定-mule-のみ)クラスター用のポリシーの設定 (Mule のみ)

同じ 3 件の要求の設定例で、ウィンドウが 12:00:00 ちょうどに開始され、10 秒ごとにリセットされて、2 ノードのクラスターを使用するとします。両方のノードは同時にそれぞれのウィンドウを開始して終了し、クラスターではウィンドウごとに合計 3 件の要求が許可されます。

![2 つのノードの受け入れられた要求と拒否された要求を追跡するタイムラインチャート](/mulesoft/current/ja-jp/mule-gateway/_images/rate-limiting-configure-clusters.png)

ポリシーがクラスタリングされているため、クラスター全体で 3 件の要求を受け入れます。クラスタリングポリシーが無効化されると、Mule クラスターはウィンドウごとに 6 件の要求 (ノードごとに 3 件の要求) を受け入れることができます。

分散されたカウンターによってノードの同期が必要となり、その結果として発生するパフォーマンスの低下を回避するため、ポリシーではキャッシュメカニズムを使用して動作を予測し、スループットを最大化します。ただし、一部のシナリオではレイテンシーが増大するため、クラスタリング設定を使用する場合は注意が必要です。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">クラスター用のレート制限ポリシーを設定する場合は、Mule Runtime Engine インスタンスが Mule クラスターの一部として実行されている必要があります。</td></tr></tbody></table>

## [](#レート制限ポリシーの設定)レート制限ポリシーの設定

レート制限ポリシーを設定する場合は、ポリシーの価値を最大限に引き出せるように、環境の特定の側面を考慮する必要があります。

### [](#クラスター設定とスタンドアロン設定の選択)クラスター設定とスタンドアロン設定の選択

次のような設定により、環境で分散処理が行われている場合があります。

- 同じ API に対して複数のサーバーがある。
- 各サーバーにはそれぞれのバックエンドがある。
- 処理できる要求数はバックエンドによってのみ制限される。
- 最速の応答時間が求められる。

このようなシナリオでは、ポリシーをクラスタリング設定で実行する必要はありません。単純に、最も弱いノードのバックエンド容量を下回るようにポリシー制限を設定すれば十分です。ノードが停止した場合には、ロードバランサーが役立つことがあります。

あるいは、次のような設定により、環境で中央処理が行われている場合があります。

- 同じ API に対して複数のサーバーがある。
- 単一のバックエンドにすべてのプロキシが接続されている。
- プロキシの前にロードバランサーが設けられている。

このようなシナリオでは、クラスターは不要です。ただし、バックエンドの最大容量を超えないようにポリシーを設定する必要があります。

環境にロードバランサーが含まれていない場合は、スタンドアロンインスタンスではなくクラスターを使用することで、変動するトラフィックレベルにノードが対応できるようにしてください。レート制限ポリシーは、ワークロードが分散されていても分散されていなくても機能するように設計されています。バックエンドは過剰な要求を受け取らないため、最大容量を超えることはありません。

### [](#クラスターノードのウィンドウサイズの選択)クラスターノードのウィンドウサイズの選択

1 分より長い処理ウィンドウを使用するように環境を設定することで、クラスター内のノードが情報を共有することで発生する潜在的なレイテンシーを防止します。

この設定の推奨事項は、クラスターシナリオでのレート制限ポリシーとレート制限 SLA ポリシーの両方に適用されます。

### [](#レート制限ポリシーの永続性の選択-mule-のみ)レート制限ポリシーの永続性の選択 (Mule のみ)

レート制限ポリシーは、数日、数か月、あるいは数年に渡って永続するウィンドウを使用するように設定できます。たとえば、1 年間に 100 万件の要求をコンシュームできるようにしたいものの、その期間全体に渡ってノードが稼動しているかどうか、あるいは Mule Runtime Engine の再起動が発生するメンテナンスが必要になるかどうかについては確信が持てないとします。

アルゴリズムはすでに数か月間実行されているため、クライアントは重要な情報を失います。永続性では、現在のポリシー状態を定期的に保存することによってこの問題を解決します。再デプロイメントや再起動が発生した場合、アルゴリズムは最後の既知の永続的な状態から再作成されるか、クリーンな状態から開始されます。

永続性はデフォルトで有効になっていますが、次のプロパティを false に設定することで無効にできます。

`throttling.persistence_enabled`

また、永続性の頻度を調整できます。デフォルトは 10 秒です。

`throttling.persistent_data_update_freq`

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>永続性は CloudHub では使用できません。
CloudHub 2.0 の ObjectStore v2 で提供される永続性はサポートされていません。</p>
</div>
</td>
</tr>
</tbody></table>

## [](#faq)FAQ

**このウィンドウはいつ開始されますか?**

このウィンドウは、ポリシーが正常に適用された後の最初の要求で開始されます。

**アルゴリズムが使用するウィンドウの種別は?**

固定ウィンドウです。

**クォータを使い果たすとどうなりますか?**

アルゴリズムは、最初の要求を受信したときにオンデマンドで作成されます。このイベントによって、期間が固定されます。各要求は、期間が終了するまで、現在のウィンドウの要求クォータをコンシュームします。

要求クォータを使い果たすと、レート制限ポリシーは要求を拒否します。ウィンドウが終了すると、要求クォータはリセットされ、同じ固定サイズの新しいウィンドウが開始されます。

**複数の制限を定義するとどうなりますか?**

ポリシーはウィンドウあたりの要求クォータ設定を使用して各制限のアルゴリズムを作成します。そのため、複数の制限が設定されている場合、要求が受け入れられるには、すべてのアルゴリズムに現在のウィンドウで使用可能な要求クォータが存在する必要があります。

**各レスポンスヘッダーの意味は?**

各レスポンスヘッダーは、要求の現在の状態に関する情報を返します。

- X-Ratelimit-Remaining: 使用可能な要求クォータ
- X-Ratelimit-Limit: 各ウィンドウで使用可能な最大要求数
- X-Ratelimit-Reset: 新しいウィンドウが開始されるまでの残り時間 (ミリ秒)

デフォルトでは、応答の X-RateLimit ヘッダーは無効になっています。これらのヘッダーを有効にするには、ポリシーの設定時に ​**\[Expose Headers (ヘッダーを公開)\]**​ を選択します。

**Mule クラスターを CloudHub で設定できますか?**

いいえ。この機能は、RTF、ハイブリッド、およびスタンドアロン Mule 設定でのみ使用できます。

**レート制限 SLA やスパイク制御ではなくレート制限ポリシーを使用する必要がある状況は?**

レート制限ポリシーと​**レート制限 SLA**​ ポリシーは、説明責任を果たすためにハード制限を (レート制限で識別子を使用して) グループまたは (​**レート制限 SLA**​ を使用して) クライアントアプリケーションに適用する場合に使用します。バックエンドを保護するには、代わりに​**スパイク制御**​を使用してください。