Tous les produits
Search

Ce produit

    API Gateway:Gérer les plugins

    Centre de documentation

    API Gateway:Gérer les plugins

    Dernière mise à jour :Aug 09, 2026

    Cloud-native API Gateway propose des plugins intégrés pour l'authentification, le contrôle du trafic et la protection de la sécurité. Il prend également en charge les plugins personnalisés pour étendre les fonctionnalités de la passerelle de manière flexible. Vous pouvez installer, activer, désinstaller et gérer les versions des plugins, y compris effectuer des mises à jour continues sans interruption, ainsi que des mises à niveau et des rétrogradations.

    Présentation des plugins

    Les plugins Cloud-native API Gateway se répartissent en trois catégories selon leur origine :

    • Plugins officiels : plugins publiés par l'équipe Higress.

    • Plugins communautaires : plugins contribués par la communauté Higress.

    • Plugins personnalisés : plugins téléchargés par les utilisateurs pour leur propre usage.

    Installer et activer un plugin

    Pour utiliser un plugin, sélectionnez-le dans la console Cloud-native API Gateway et installez-le sur une instance de passerelle. Un plugin ne devient effectif qu'après son installation, la configuration de ses règles et son activation. Deux méthodes d'installation sont disponibles :

    Remarque

    • MCP/Route Level Plugin Rules : ces règles s'appliquent aux routes et entrent en vigueur lorsqu'une requête correspond à une route spécifique.

    • Domain-level plug-in rules : ces règles s'appliquent aux noms de domaine. Les règles associées à des noms de domaine spécifiques ont une priorité plus élevée que celles liées aux noms de domaine génériques.

    • Instance-level plug-in rules : ces règles s'appliquent globalement à la passerelle et sont utilisées lorsqu'aucune règle au niveau du routage ou du domaine ne correspond.

    Méthode 1 : Installer depuis l'extérieur d'une instance de passerelle

    1. Accédez à la page Plugins de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Sur la page Plug-in, dans le volet Quick Navigation, sélectionnez un type de plugin ou recherchez un plugin par son nom. Cliquez sur Install failed. sur la carte du plugin. Dans la boîte de dialogue Install Plug-in, sélectionnez l'instance de passerelle cible pour le plugin, puis cliquez sur OK.

    3. Dans la section Configuration, repérez l'instance de passerelle cible et cliquez sur Rule Configuration dans la colonne Actions. Sur la page de configuration des règles, sélectionnez une Effective Scope.

      • Si vous sélectionnez MCP/Route Level Plugin Rules ou Domain-level plug-in rules, cliquez sur Add Rule. Sur la page Add Routing Level Rule ou Add Domain Level Rule, activez l'option Status (activée par défaut). Sélectionnez une Target, configurez les Plug-in Rules, puis cliquez sur OK.

      • Si vous sélectionnez Instance-level plug-in rules, activez l'option Status (activée par défaut), configurez les Plug-in Rules, puis cliquez sur Save.

    Méthode 2 : Installer depuis l'intérieur d'une instance de passerelle

    1. Accédez à la page Instances de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Accédez à la page de détails de l'instance cible. Dans le volet de navigation de gauche, sélectionnez Plug-in.

    3. Cliquez sur Install Plug-in. Sur la page d'installation du plugin, utilisez le volet Quick Navigation pour sélectionner un type de plugin ou rechercher un plugin par son nom. Cliquez sur la carte du plugin, puis sur Install and Configure dans la boîte de dialogue qui s'affiche.

    4. Dans la boîte de dialogue Rule Configuration, configurez les règles du plugin sélectionné, choisissez une portée d'application, puis cliquez sur OK.

    5. (Facultatif) Sur la page de l'instance de passerelle, sélectionnez Plug-in dans le volet de navigation de gauche. Dans la liste des plugins, repérez le plugin cible et cliquez sur Rule Configuration dans la colonne Actions. Configurez ensuite les règles et sélectionnez une portée d'application.

      • Si vous sélectionnez MCP/Route Level Plugin Rules ou Domain-level plug-in rules, cliquez sur Add Rule. Sur la page Add Routing Level Rule ou Add Domain Level Rule, activez l'option Status (activée par défaut), sélectionnez une Target, configurez les Plug-in Rules, puis cliquez sur OK.

      • Si vous sélectionnez Instance-level plug-in rules, activez l'option Status (activée par défaut), configurez les Plug-in Rules, puis cliquez sur Save.

    Désinstaller un plugin

    Contexte

    La désinstallation d'un plugin le supprime entièrement d'une passerelle. Deux méthodes de désinstallation sont disponibles.

    Important

    Avant de désinstaller un plugin, désactivez toutes les règles actives associées. Si le plugin n'est pas activé, sa désinstallation entraîne également la suppression de toutes les règles configurées.

    Méthode 1 : Désinstaller depuis l'extérieur d'une instance de passerelle

    1. Accédez à la page Plugins de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Sur la page Plug-in, dans le volet Quick Navigation, sélectionnez un type de plugin ou recherchez un plugin par son nom. Cliquez sur la carte du plugin que vous souhaitez désinstaller.

    3. Cliquez sur l'onglet Configuration. Repérez l'instance de passerelle depuis laquelle vous souhaitez désinstaller le plugin et cliquez sur Uninstall dans la colonne Actions.

    4. Dans la boîte de dialogue qui s'affiche, cliquez sur le bouton OK. Un message confirme la réussite de la désinstallation du plugin.

    Méthode 2 : Désinstaller depuis l'intérieur d'une instance de passerelle

    1. Accédez à la page Instances de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Accédez à la page de détails de l'instance cible et, dans le volet de navigation de gauche, sélectionnez Plug-in.

    3. Dans la liste des plugins, repérez le plugin que vous souhaitez désinstaller et cliquez sur Uninstall dans la colonne Actions.

    4. Dans la boîte de dialogue qui s'affiche, cliquez sur le bouton OK. Un message confirme la réussite de la désinstallation du plugin.

    Ajouter une version à un plugin personnalisé

    Important

    Vous ne pouvez pas ajouter de versions aux plugins Lua personnalisés.

    L'ajout d'une version crée un nouvel enregistrement de version pour chaque modification apportée à un plugin personnalisé, ce qui vous aide à suivre les changements et à contrôler les déploiements. Procédez comme suit :

    1. Accédez à la page Plugins de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Sur la page Plug-in, dans le volet Quick Navigation, définissez le paramètre Plug-in Type sur Custom ou recherchez un plugin par son nom. Cliquez sur Add Version sur la carte du plugin. Dans le panneau Add Version, configurez les Version Information :

      • Version : saisissez le numéro de version du plugin. Le numéro de version doit respecter la spécification de versionnement sémantique (semver), par exemple 1.0.1.

      • Version Description : brève description des fonctionnalités et des modifications apportées dans cette version, par exemple Added rate limiting feature.

      • WASM File : fichier compilé .wasm qui exécute la logique du plugin dans la passerelle.

      • Execution Stage : sélectionnez la phase du flux de traitement des requêtes durant laquelle le plugin est exécuté, par exemple Default Phase.

      • Execution Priority : saisissez un nombre pour définir l'ordre d'exécution du plugin. Plus le nombre est élevé, plus la priorité est grande.

      • Adapt to Gateway Version : saisissez le numéro de version du moteur de passerelle avec lequel ce plugin est compatible. Cela garantit le bon fonctionnement du plugin.

        Remarque

        Il s'agit de la version minimale de la passerelle sur laquelle ce plugin peut être installé.

    Changement de version d'un plugin

    Important

    Pour garantir une mise à niveau fluide, assurez-vous que la nouvelle version est compatible avec la configuration des règles de la version d'origine.

    1. Accédez à la page Instances de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Accédez à la page de détails de l'instance cible. Dans le volet de navigation de gauche, sélectionnez Plug-in.

    3. Dans la liste des plugins, repérez le plugin cible. Ensuite, cliquez sur Version Change dans la colonne Actions.

    4. Dans la boîte de dialogue Version Change, sélectionnez la version souhaitée, puis cliquez sur OK.

    Supprimer une version

    1. Accédez à la page Plugins de la console Cloud-native API Gateway. Dans la barre de menu supérieure, sélectionnez une région.

    2. Sur la page Plug-in, trouvez un plugin en définissant le paramètre Plug-in Type sur Custom dans le volet Quick Navigation ou en recherchant le plugin par son nom. Pointez sur l'icône image sur la carte du plugin.

    3. Cliquez ensuite sur Deleted.. Dans la boîte de dialogue qui s'affiche, sélectionnez la version à supprimer et cliquez sur OK.