ゲートウェイのパフォーマンスを向上させるためにゲートウェイパラメーターを変更する - API Gateway

クラウドネイティブ API ゲートウェイエンジンの適切な構成は、ネットワークパフォーマンス、信頼性、セキュリティを向上させ、安定した運用とユーザーエクスペリエンスを保証します。この記事では、パラメーターの調整方法を紹介し、各パラメーターの詳細について説明します。

前提条件

クラウドネイティブ API ゲートウェイを作成します。

手順

説明

インスタンスの安定性を確保するため、コンソールに表示されるパラメーターのみ変更できます。
パラメーター値を変更する前に、コンソールの [ゲートウェイエンジンパラメーター] ページで有効な範囲をご参照ください。

API Gateway コンソールにログオンします。
左側のナビゲーションウィンドウで、[クラウドネイティブ API ゲートウェイ] > [インスタンス] をクリックします。上部のナビゲーションバーで、リージョンを選択します。
[インスタンス] ページで、対象のインスタンス ID をクリックします。
左側のナビゲーションウィンドウで、[パラメーター設定] を選択します。[ゲートウェイエンジンパラメーター] セクションで、対象のパラメーターを見つけ、[操作] 列の [編集] をクリックします。次の表に従ってパラメーター値を設定し、[OK] をクリックします。

ゲートウェイエンジンパラメーターの説明

パラメーター	タイプ	有効値	デフォルト値	説明
EnableHttp2	bool	[true, false]	false	リクエストフェーズに適用されます。サーバーとクライアントがプロトコルをネゴシエートする際に HTTP/2 を使用するかどうかを指定します。 true: HTTP/2 を使用します。 false: HTTP/2 を使用しません。
EnableGenerateRequestId	bool	[true, false]	true	リクエストスコープに適用されます。有効にすると、ゲートウェイはリクエストヘッダーにリクエスト ID (X-Request-Id) を生成して、リクエストを一意に識別します。 true: リクエストヘッダーにリクエスト ID を生成します。 false: リクエストヘッダーにリクエスト ID を挿入しません。
EnableGzip	bool	[true, false]	false	応答フェーズに適用されます。 true: Gzip を使用して応答を圧縮します。これにより、ゲートウェイのトラフィックは減少しますが、ゲートウェイの CPU 消費量は増加します。 false: 元の応答を返します。
EnableGzipHardwareAccelerate	bool	[true, false]	false	専用ハードウェアに基づいて Gzip 圧縮を実行します。有効にすると、応答が圧縮され、ゲートウェイのトラフィックが大幅に削減されます。この方法は、ソフトウェアベースの Gzip 圧縮よりも高いパフォーマンスと低い CPU 消費量を提供します。 true: Gzip ハードウェアアクセラレーションを有効にします。 false: Gzip ハードウェアアクセラレーションを無効にします。重要この機能は、サポートされていないリージョン、またはインスタンスの購入時に Gzip ハードウェアアクセラレーションを有効にしなかった場合は利用できません。この機能を有効にすると、EnableGzip および ZipAlgorithm パラメーターは有効にならなくなります。
EnableSlashMerge	bool	[true, false]	false	リクエストフェーズに適用されます。リクエストパス内の連続するスラッシュ (`/`) をマージするかどうかを指定します。 true: `www.example.com//b` の冗長な `/` がマージされ、`www.example.com/b` と同じになります。 false: 連続するスラッシュ (`/`) はマージされません。
DownstreamIdleTime	integer	[0, 600]	300	ゲートウェイ接続に適用されます。指定された期間内にクライアントからゲートウェイにリクエストが送信されない場合、接続は閉じられます。単位: 秒。
PreserveHeaderFormat	bool	[true, false]	false	リクエストおよび応答フェーズに適用されます。HTTP/1.1 仕様によると、ヘッダー名では大文字と小文字が区別されません。HTTP/2 仕様との互換性を確保するため、ヘッダー名はデフォルトで小文字に変換されます。 true: リクエストヘッダーと応答ヘッダーの大文字と小文字を保持します。 false: リクエストヘッダーと応答ヘッダーを小文字に変換します。
DownstreamConnectionBufferLimits	integer	[0, 2147483647]	32768	ゲートウェイ接続に適用されます。単一接続のバッファーサイズを制御します。この設定は、スループットとゲートウェイのメモリ使用量に影響します。単位: バイト。
EnableHardwareAccelerate	bool	[true, false]	true	TLS の暗号化と復号に適用されます。ハードウェアアクセラレーションを有効にするかどうかを指定します。お使いのリージョンがハードウェアアクセラレーションをサポートしていない場合、またはインスタンスの購入時に有効にしなかった場合、このパラメーターは有効になりません。 true: ハードウェアアクセラレーションを有効にします。 false: ハードウェアアクセラレーションを無効にします。説明ハードウェアの制限により、ハードウェアアクセラレーションは、中国 (北京)、中国 (杭州)、中国 (上海)、中国 (深圳)、およびアジア太平洋 SE 1 (シンガポール) リージョンでのみサポートされています。
XffTrustedNum	integer	[0, 10]	0	リクエストフェーズに適用され、ゲートウェイの前にある信頼できるプロキシの数を指定します。これは、ゲートウェイが x-forwarded-for や x-request-id などのクライアント生成のリクエストヘッダーを使用するかどうかに影響します。値が 0 の場合、ゲートウェイはピアソケットの IP アドレスを送信元 IP アドレスとして使用し、`x-envoy-external-address` リクエストヘッダーでバックエンドに渡します。値が 0 でない場合、ゲートウェイは `x-forwarded-for` ヘッダーから送信元 IP アドレスを決定します。これにはすでにソケット IP アドレスが含まれています。ゲートウェイは、指定された数のホップを右から左にスキップし、送信元 IP アドレスを抽出します。この IP アドレスは、`x-envoy-external-address` リクエストヘッダーでバックエンドに渡されます。ゲートウェイはまた、クライアントが送信した `x-request-id` および `x-forwarded-proto` ヘッダーを変更せずに保持します。
DownstreamHttp2MaxConcurrentStream	integer	[0, 2147483647]	100	リクエストフェーズに適用されます。クライアントが HTTP/2 を使用する場合の単一接続での同時ストリームの最大数。
InitialStreamWindowSize	integer	[65535, 2147483647]	65535	リクエストフェーズに適用されます。HTTP/2 を使用する場合にゲートウェイとクライアント間でネゴシエートされる初期ストリームウィンドウサイズ。単位: バイト。
InitialConnectionWindowSize	integer	[0, 2147483647]	1048576	リクエストフェーズに適用されます。ゲートウェイとクライアントが HTTP/2 を使用する場合の初期接続レベルのウィンドウサイズ。単位: バイト。
EnableHttp3	bool	[true, false]	false	リクエストフェーズに適用されます。ダウンストリームクライアントとゲートウェイが HTTP/3 を使用するかどうかを指定します。 true: HTTP/3 を使用します。 false: HTTP/3 を使用しません。
UpstreamIdleTimeout	int	[0, 600]	30	ゲートウェイ接続に適用されます。指定された期間内にゲートウェイからアップストリームサービスにリクエストが送信されない場合、接続は閉じられます。単位: 秒。
PathWithEscapedSlashes	string	KEEP_UNCHANGED REJECT_REQUEST UNESCAPE_AND_REDIRECT UNESCAPE_AND_FORWARD	KEEP_UNCHANGED	Uniform Resource Identifier (URI) パスに %2F、%2f、%5C、または %5c などのエスケープ文字が含まれるリクエストの転送ルール。 KEEP_UNCHANGED: パスを変更せずに保持します。 REJECT_REQUEST: ゲートウェイは 400 エラーを返し、リクエストを拒否します。 UNESCAPE_AND_REDIRECT: 文字をアンエスケープし、リダイレクトを実行します。 UNESCAPE_AND_FORWARD: 文字をアンエスケープし、リクエストを転送します。
ZipAlgorithm	List<string>	[brotli, gzip]	gzip	圧縮が有効になった後に使用するアルゴリズム。brotli または gzip を選択できます。 gzip と brotli の両方を指定し、`Accept-Encoding` ヘッダーの q 値が同じ場合、リストの最初に表示されるアルゴリズムが使用されます。
EnableProxyProtocol	bool	[true, false]	false	Proxy プロトコルを有効にします。ゲートウェイのイングレストラフィックが Network Load Balancer (NLB) を介してルーティングされる場合、クライアントの送信元 IP アドレスを取得するには、この機能を有効にする必要があります。この機能を有効にしても、Proxy プロトコルを使用しないリクエストには影響しません。
EnableCustomAuthConfigPush	bool	[true, false]	false	自己管理型の認証サービスが使用されるシナリオに適用されます。有効にすると、認証ルールの変更によって接続が中断されることはありません。これは、WebSocket およびオンラインビジネスシナリオに適しています。