Modify cloud-native API gateway engine parameters - API Gateway

Pour s'adapter aux différents scénarios, ajustez les paramètres d'une passerelle API cloud-native. Un réglage approprié améliore les performances réseau, la fiabilité et la sécurité, garantissant ainsi un fonctionnement stable et une meilleure expérience utilisateur. Toutefois, la modification des paramètres de la passerelle peut affecter la connectivité réseau et les applications qui l'utilisent. Avant toute modification, assurez-vous de comprendre la plage valide et l'impact de chaque paramètre modifiable. Cette rubrique décrit la procédure de modification des paramètres de la passerelle et fournit des détails sur chacun d'eux.

Prérequis

Une passerelle est créée. Pour plus d'informations, consultez Créer une passerelle API cloud-native.

Étapes

Remarque

Seuls les paramètres affichés dans la console sont modifiables. Cette restriction garantit le fonctionnement stable de l'instance.
Avant de modifier la valeur d'un paramètre, vérifiez la colonne Value Range sur la page Gateway Engine Parameters de la console.

Connectez-vous à la console API Gateway.
Dans le volet de navigation de gauche, cliquez sur Cloud-native API Gateway > Instance. Dans la barre de navigation supérieure, sélectionnez une région.
Sur la page Instance, cliquez sur l'ID de l'instance cible.
Dans le volet de navigation de gauche, choisissez Parameters. Dans la section Gateway Engine Parameters, recherchez le paramètre cible, cliquez sur Edit dans la colonne Actions, définissez la valeur du paramètre comme indiqué dans le tableau suivant, puis cliquez sur OK.

Paramètres du moteur de passerelle

Parameter Name	Parameter Type	Value Range	Valeur par défaut	Parameter Description
EnableHttp2	bool	[true, false]	false	Phase de requête. Indique s'il faut utiliser HTTP/2 lors de la négociation de protocole. true : Utiliser HTTP/2. false : Ne pas utiliser HTTP/2.
EnableGenerateRequestId	bool	[true, false]	true	Phase de requête. Lorsqu'elle est activée, la passerelle génère un en-tête X-Request-Id pour identifier de manière unique chaque requête. true : Génère un en-tête X-Request-Id. false : Ne génère pas d'en-tête X-Request-Id.
EnableGzip	bool	[true, false]	false	Phases de requête et de réponse. true : Compresse les réponses avec Gzip, ce qui réduit le trafic de la passerelle mais augmente l'utilisation du CPU de la passerelle. false : Renvoie la réponse d'origine.
EnableGzipHardwareAccelerate	bool	[true, false]	false	Compression Gzip accélérée par le matériel. Réduit considérablement le trafic de la passerelle avec des performances supérieures et une utilisation du CPU inférieure à celle de Gzip logiciel. true : Active l'accélération matérielle Gzip. false : Désactive l'accélération matérielle Gzip. Important Indisponible dans les régions non prises en charge ou si l'accélération matérielle Gzip n'a pas été activée lors de l'achat. Lorsqu'elle est activée, les paramètres EnableGzip et ZipAlgorithm ne prennent plus effet.
EnableSlashMerge	bool	[true, false]	false	Phase de requête. Indique s'il faut fusionner les barres obliques consécutives (`/`) dans le chemin de la requête. true : Fusionne les caractères `/` redondants. Par exemple, `www.example.com//b` est traité de la même manière que `www.example.com/b`. false : Les caractères `/` redondants ne sont pas fusionnés.
DownstreamIdleTime	integer	[0, 600]	180	Connexions de passerelle. Ferme les connexions client-vers-passerelle inactives pendant la durée spécifiée. Unité : secondes.
PreserveHeaderFormat	bool	[true, false]	false	Phases de requête et de réponse. Par défaut, les noms d'en-tête sont convertis en minuscules pour la compatibilité HTTP/2. true : Conserve la casse des en-têtes de requête et de réponse. false : Convertit les en-têtes de requête et de réponse en minuscules.
DownstreamConnectionBufferLimits	integer	[0, 2147483647]	32768	Connexions de passerelle. Contrôle la taille du tampon par connexion, affectant le débit et l'utilisation de la mémoire. Unité : octets.
EnableHardwareAccelerate	bool	[true, false]	true	Chiffrement et déchiffrement TLS. Active le traitement TLS accéléré par le matériel. Ne prend pas effet si l'accélération matérielle n'est pas prise en charge dans votre région ou n'a pas été activée lors de l'achat. true : Active l'accélération matérielle. false : Désactive l'accélération matérielle. Remarque En raison des limitations matérielles sous-jacentes, l'accélération matérielle est actuellement prise en charge uniquement dans les régions Chine (Pékin), Chine (Hangzhou), Chine (Shanghai), Chine (Shenzhen) et Singapour.
XffTrustedNum	integer	[0, 10]	0	Phase de requête. Nombre de proxys approuvés avant la passerelle, affectant la gestion des en-têtes générés par le client tels que x-forwarded-for et x-request-id. Si la valeur est définie sur 0, la passerelle utilise l'adresse IP du socket pair comme adresse IP d'origine et la transmet au backend dans l'en-tête x-envoy-external-address. Si la valeur est différente de zéro, la passerelle détermine l'adresse IP d'origine à partir de l'en-tête x-forwarded-for en ignorant le nombre spécifié de sauts de droite à gauche. Cette adresse IP est transmise au backend dans l'en-tête x-envoy-external-address. La passerelle conserve également les en-têtes x-request-id et x-forwarded-proto envoyés par le client.
DownstreamHttp2MaxConcurrentStream	integer	[0, 2147483647]	100	Phase de requête. Nombre maximal de flux HTTP/2 simultanés par connexion client.
InitialStreamWindowSize	integer	[65535, 2147483647]	65535	Phase de requête. Taille initiale de la fenêtre de contrôle de flux au niveau du flux HTTP/2. Unité : octets.
InitialConnectionWindowSize	integer	[0, 2147483647]	1048576	Phase de requête. Taille initiale de la fenêtre de contrôle de flux au niveau de la connexion HTTP/2. Unité : octets.
EnableHttp3	bool	[true, false]	false	Phase de requête. Indique s'il faut utiliser HTTP/3 pour la communication client-vers-passerelle. true : Utiliser HTTP/3. false : Ne pas utiliser HTTP/3.
UpstreamIdleTimeout	int	[0, 600]	30	Connexions de passerelle. Ferme les connexions passerelle-vers-upstream inactives pendant la durée spécifiée. Unité : secondes.
PathWithEscapedSlashes	string	KEEP_UNCHANGED REJECT_REQUEST UNESCAPE_AND_REDIRECT UNESCAPE_AND_FORWARD	KEEP_UNCHANGED	Règle de transfert pour les requêtes dont le chemin URI contient des barres obliques encodées (%2F, %2f, %5C ou %5c). KEEP_UNCHANGED : Conserve le chemin inchangé. REJECT_REQUEST : La passerelle renvoie une erreur 400 et rejette la requête. UNESCAPE_AND_REDIRECT : Décode les caractères et effectue une redirection. UNESCAPE_AND_FORWARD : Décode les caractères et transfère la requête.
ZipAlgorithm	List<string>	[brotli, gzip]	gzip	Algorithme de compression. Valeurs prises en charge : brotli, gzip. Lorsque les deux algorithmes sont spécifiés avec des valeurs q égales dans Accept-Encoding, le premier algorithme de la liste est prioritaire.
EnableProxyProtocol	bool	[true, false]	false	Active le protocole PROXY. Requis lorsque le trafic entrant passe par un Network Load Balancer (NLB) pour obtenir l'adresse IP d'origine du client. N'affecte pas les requêtes qui n'utilisent pas le protocole PROXY.
EnableCustomAuthConfigPush	bool	[true, false]	false	Scénarios d'authentification gérés par l'utilisateur. Lorsqu'elle est activée, les modifications des règles d'authentification n'interrompent pas les connexions existantes. Adapté aux scénarios WebSocket et aux activités en ligne.