Créer une passerelle API cloud native - API Gateway - Centre de documentation Alibaba Cloud

Configuration de base

Autorisation initiale

Stratégies d'autorisation système :

AliyunServiceRoleForNativeApiGw : permet d'accéder à d'autres services Alibaba Cloud tels que Container Service for Kubernetes (ACK), Virtual Private Cloud (VPC), Server Load Balancer (SLB) et Microservices Engine (MSE).

AliyunServiceRolePolicyForNativeApiGwInvokeFC : permet d'accéder au service Function Compute (FC).

Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, cliquez sur Instance. Sur la page Instances, cliquez sur Instance Creation. Sur la page d'achat de Cloud-native API Gateway, configurez les paramètres suivants :

Product Type : sélectionnez Pay-as-you-go ou Subscription. Consultez la vue d'ensemble de la facturation.
- Paiement à l'utilisation : facturation horaire. Toute utilisation inférieure à une heure est arrondie à l'heure supérieure et la facturation est réglée toutes les heures.
- Abonnement : facturation mensuelle. Un abonnement annuel équivaut à 12 mois.
Region : sélectionnez la région où résident vos backend services. La région ne peut pas être modifiée après la création.
Gateway Name : saisissez un nom personnalisé (jusqu'à 64 caractères). Utilisez un nom combinant l'environnement et le domaine métier, par exemple test ou order-prod.

GatewaySpec : évaluez la capacité nécessaire et sélectionnez une spécification de nœud en fonction de vos besoins métier.

Seuils de capacité pour différentes spécifications de nœuds

Maintenez les métriques de capacité sous le seuil d'avertissement afin de garantir le respect des SLA. Pour les charges de travail critiques, restez sous le seuil de sécurité pour une stabilité accrue.

Seuil de sécurité : la passerelle maintient un débit élevé et une faible latence, même si le trafic double.
Seuil d'avertissement : au-delà de ce niveau, la passerelle peut connaître une latence plus élevée et des risques de stabilité lors des pics de trafic.
Les passerelles à nœud unique ne bénéficient d'aucune garantie SLA et sont réservées aux tests. Les charges de production nécessitent des spécifications multi-nœuds.

Spécification de la passerelle	Connexions client		Nouvelles connexions HTTPS		Utilisation du CPU		Utilisation de la mémoire
Spécification de la passerelle	Seuil de sécurité	Seuil d'avertissement	Seuil de sécurité	Seuil d'avertissement	Seuil de sécurité	Seuil d'avertissement	Seuil de sécurité	Seuil d'avertissement
`apigw.dev.x1`	12 000	24 000	400	800	30 %	60 %	75 %	75 %
`apigw.small.x1`	24 000	48 000	800	1 600	30 %	60 %	75 %	75 %
`apigw.small.x2`	48 000	96 000	1 600	3 200	30 %	60 %	75 %	75 %
`apigw.small.x4`	96 000	192 000	3 200	6 400	30 %	60 %	75 %	75 %
`apigw.medium.x1`	192 000	384 000	6 400	12 800	30 %	60 %	75 %	75 %
`apigw.medium.x2`	384 000	768 000	12 800	25 600	30 %	60 %	75 %	75 %
`apigw.medium.x3`	576 000	1 152 000	19 200	38 400	30 %	60 %	75 %	75 %
`apigw.large.x1`	768 000	1 536 000	25 600	51 200	30 %	60 %	75 %	75 %
`apigw.large.x2`	1 536 000	3 072 000	51 200	102 400	30 %	60 %	75 %	75 %
`apigw.large.x3`	2 304 000	4 608 000	76 800	153 600	30 %	60 %	75 %	75 %
`apigw.large.x4`	3 072 000	6 144 000	102 400	204 800	30 %	60 %	75 %	75 %

Resource Group : sélectionnez un groupe de ressources existant ou utilisez le groupe par défaut. Les groupes de ressources vous permettent de gérer les ressources, les permissions et la surveillance en tant qu'unité. Pour en créer un, cliquez sur Create Resource Group.
Network Type : sélectionnez Internet, Private Network ou Public + private network.
- Internet : l'accès au réseau public entraîne des frais de trafic facturés via Cloud Data Transfer (CDT) selon le modèle BGP (Multi-ISP). Trafic réseau public.
- Private Network : aucun frais de trafic n'est encouru pour l'accès via le réseau privé.
- Public + private network : l'accès public entraîne des frais de trafic CDT (modèle BGP Multi-ISP). L'accès privé est gratuit.
VPC : sélectionnez le VPC dans lequel la passerelle s'exécutera. La passerelle et les backend services doivent partager le même VPC.
Sélection de la zone de disponibilité : choisissez Auto-assign ou Manual select.
- Auto-assign : sélectionnez des vSwitches pour les nœuds de la passerelle. Le système déploie automatiquement les nœuds sur deux zones de disponibilité.
- Manual select : sélectionnez manuellement la Availability zone et les vSwitches pour les nœuds de la passerelle.

Cliquez sur Buy Now, vérifiez la configuration sur la page Confirm Order, puis cliquez sur Open now.

La création de l'instance de passerelle prend de 1 à 5 minutes.
Sur la page Instance, vérifiez que le statut de l'instance est Running.

Fonctionnalités avancées

Configurez les fonctionnalités avancées lors de la création de l'instance pour activer l'analyse des journaux ou la compression Gzip. L'accélération matérielle Gzip ne peut être activée qu'au moment de la création. Le service de journalisation peut être activé à tout moment.

Activer l'accélération matérielle Gzip

L'accélération matérielle Gzip décharge la compression et la décompression des données vers du matériel dédié, réduisant ainsi la charge du CPU et améliorant l'efficacité du traitement.

Étapes

Sur la page d'achat, complétez la Configuration de base et définissez les paramètres supplémentaires suivants. Ensuite, cliquez sur Open now.
- Region : l'accélération matérielle Gzip est disponible dans les régions suivantes : China (Hangzhou), China (Beijing), China (Shanghai), China (Shenzhen), China (Ulanqab), China (Hong Kong) et Singapore.
  
  Au sein de ces régions prises en charge, certaines zones de disponibilité peuvent ne pas prendre en charge cette fonctionnalité. La disponibilité dépend des options affichées sur la page d'achat du produit.
- GatewaySpec : sélectionnez une spécification apigw.medium.x1 ou supérieure.
- Gzip hardware acceleration : cochez la case pour activer l'accélération matérielle Gzip.
Une fois l'instance créée, cliquez sur son nom ou son ID pour accéder à la page des détails. Dans le volet de navigation de gauche, cliquez sur Parameters. Dans la section Gateway Engine Parameters, modifiez le paramètre EnableGzipHardwareAccelerate.

Si vous n'avez pas coché la case Gzip hardware acceleration lors de l'achat, vous ne pourrez pas activer ce paramètre.
Après avoir activé cette fonctionnalité, les clients doivent être capables de traiter les données compressées en Gzip et doivent inclure l'en-tête Accept-Encoding: gzip dans leurs requêtes.

Référence de performance

Économies de trafic Gzip

Le taux de compression Gzip (taille compressée / taille originale) dépend des caractéristiques des données. Un taux plus faible indique une meilleure compression.

Les textes présentant des motifs répétitifs (lettres, mots, ponctuation) se compressent bien, offrant des taux faibles. Les données à haute entropie (images, vidéos, fichiers déjà compressés) offrent des taux élevés avec un avantage limité.

Sur la base des données de production des instances avec Gzip activé dans les régions principales, la plupart atteignent un taux de compression de 10 % à 50 %, économisant en moyenne plus de 50 % du trafic.

Économies de ressources avec l'accélération matérielle

Le test de stress suivant compare l'utilisation du CPU entre une instance à nœud unique avec Gzip matériel et une instance à quatre nœuds avec Gzip logiciel, pour un même QPS.

Dans cet exemple, les données compressées sont un fichier texte JSON d'environ 120 Ko.

QPS	Utilisation du CPU (Gzip matériel)	Utilisation du CPU (Gzip logiciel)
2 000	9 %	11 %
5 000	26 %	28 %
10 000	56 %	56 %
13 000	69 %	72 %

L'utilisation du CPU de Enabled Gzip hardware acceleration/single node est comparable à celle de Software Gzip/4 nodes, permettant d'économiser environ 75 % des ressources de l'instance.

Activer la livraison des journaux de la passerelle

Activez Simple Log Service (SLS) lors de la création de l'instance pour collecter, stocker et analyser les journaux de la passerelle.

Lors de la configuration de la Configuration de base, cochez la case Use Simple Log Service (SLS). Le système provisionne automatiquement SLS et active la fonctionnalité de livraison des journaux de la passerelle pour vous.

Après avoir activé la livraison des journaux, vous pouvez consulter les journaux de la passerelle en accédant à Observation and Analysis > Logs.

Description des champs de journal

Champ	Type	Description
__time__	long	L'heure de génération du journal.
cluster_id	string	L'ID de l'instance AI Gateway.
ai_log	json	Un objet JSON contenant les champs de journal pour Model API, Agent API et MCP API. Ce champ est vide pour les autres types d'API. api : le nom de l'AI API. cache_status : indique si une requête a atteint le cache lorsque la mise en cache du contenu est activée pour une Model API. consumer : l'identité du consommateur. Ce champ est renseigné lorsque l'authentification du consommateur est activée. fallback_from : la route depuis laquelle la requête a basculé. Ce champ est renseigné lorsqu'une politique de fallback est activée pour une Model API. input_token : le nombre de jetons d'entrée dans la requête LLM. llm_first_token_duration : le temps jusqu'au premier jeton (TTFT) pour la requête LLM. llm_service_duration : le temps de réponse de bout en bout pour la requête LLM. model : le nom du modèle utilisé dans la requête LLM. output_token : le nombre de jetons de sortie dans la réponse LLM. response_type : le type de réponse de la requête LLM, tel que streaming ou non-streaming. safecheck_status : le résultat de la modération de contenu pour la requête LLM. token_ratelimit_status : indique si la requête a été bloquée par la limitation de débit basée sur les jetons.
authority	string	La valeur de l'en-tête Host dans la requête.
bytes_received	long	La taille du corps de la requête en octets, hors en-tête.
bytes_sent	long	La taille du corps de la réponse en octets, hors en-tête.
downstream_local_address	string	L'adresse du pod de la passerelle.
downstream_remote_address	string	L'adresse du client qui se connecte à la passerelle.
duration	long	Le temps total de traitement de la requête en millisecondes, mesuré depuis la réception du premier octet par la passerelle depuis le client jusqu'à l'envoi du dernier octet de la réponse.
method	string	La méthode HTTP.
path	string	Le chemin dans la requête HTTP.
protocol	string	La version du protocole HTTP.
request_duration	long	Le temps en millisecondes écoulé entre la réception du premier octet de la requête par la passerelle depuis le client et la réception du dernier octet.
request_id	string	Un ID unique généré par la passerelle pour chaque requête. Cet ID est inclus dans l'en-tête `x-request-id`. Vous pouvez utiliser ce champ pour journaliser et diagnostiquer les requêtes.
requested_server_name	string	Le nom du serveur utilisé pour la connexion SSL.
response_code_details	string	Contexte supplémentaire pour le code de réponse. Par exemple, `via_upstream` indique que le backend service a renvoyé le code de réponse, et `route_not_found` indique que la passerelle n'a pas trouvé de route correspondante.
response_tx_duration	long	Le temps en millisecondes écoulé entre la réception du premier octet par le service upstream et l'envoi du dernier octet au client.
route_name	string	Le nom de la route.
start_time	string	L'heure de début de la requête. L'heure est en UTC.
trace_id	string	L'ID de trace.
upstream_cluster	string	Le cluster upstream.
upstream_host	string	L'adresse IP de l'hôte upstream.
upstream_local_address	string	L'adresse locale utilisée pour se connecter au service upstream.
upstream_service_time	long	Le temps de traitement de la requête en millisecondes pour le service upstream. Cette durée inclut la latence réseau et le temps de traitement propre au service.
upstream_transport_failure_reason	string	La raison de l'échec de la connexion upstream.
user_agent	string	La valeur de l'en-tête User-Agent dans la requête.
x_forwarded_for	string	La valeur de l'en-tête `x-forwarded-for`, qui contient généralement l'adresse IP réelle du client.

Étapes suivantes

Cloud-native API Gateway prend en charge plusieurs types d'API, notamment REST API, HTTP API et WebSocket API. Vous pouvez configurer de manière flexible les règles de routage et les politiques pour différents types d'API.
Créez un service pour ajouter des backend services à la passerelle, lui permettant de découvrir et de gérer centralement leurs endpoints.
Exposer des applications dans Container Service via une HTTP API.
FAQ.