Todos os produtos
Search

Este produto

    API Gateway:Gerenciar plugins

    Central de documentação

    API Gateway:Gerenciar plugins

    Última atualização: Jun 27, 2026

    O Cloud-native API Gateway oferece plugins integrados para autenticação, controle de tráfego e proteção de segurança, além de suportar plugins personalizados para extensões flexíveis do gateway. Você pode instalar, ativar, desinstalar e gerenciar versões de plugins, incluindo atualizações contínuas sem interrupção, upgrades e downgrades.

    Introdução aos plugins

    Os plugins do Cloud-native API Gateway dividem-se em três categorias conforme a origem:

    • Plugins oficiais: lançados pela equipe Higress.

    • Plugins da comunidade: contribuídos pela comunidade Higress.

    • Plugins personalizados: enviados pelos usuários para uso próprio.

    Instalar e ativar um plugin

    Para usar um plugin, selecione-o no console do Cloud-native API Gateway e instale-o em uma instância de gateway. O plugin só entra em vigor após a instalação, a configuração das regras e a ativação. Há duas formas de instalar plugins:

    Nota

    • MCP/Route Level Plugin Rules: aplicam-se a rotas e entram em vigor quando uma requisição corresponde a uma rota específica.

    • Domain-level plug-in rules: aplicam-se a nomes de domínio. Regras para domínios específicos têm prioridade maior que regras para domínios curinga.

    • Instance-level plug-in rules: aplicam-se globalmente ao gateway e são acionadas quando nenhuma regra de nível de rota ou de domínio for correspondida.

    Método 1: Instalar fora de uma instância de gateway

    1. Acesse a página Plugins no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Na página Plug-in, no painel Quick Navigation, selecione um tipo de plugin ou pesquise pelo nome. Clique em Install failed. no cartão do plugin desejado. Na caixa de diálogo Install Plug-in, selecione a instância de gateway para o plugin e clique em OK.

    3. Na seção Configuration, localize a instância de gateway de destino e clique em Rule Configuration na coluna Actions. Na página de configuração de regras, selecione um Effective Scope.

      • Se você selecionar MCP/Route Level Plugin Rules ou Domain-level plug-in rules, clique em Add Rule. Na página Add Routing Level Rule ou Add Domain Level Rule, ative o campo Status (ativado por padrão). Selecione um Target, configure as Plug-in Rules e clique em OK.

      • Se você selecionar Instance-level plug-in rules, ative o campo Status (ativado por padrão), configure as Plug-in Rules e clique em Save.

    Método 2: Instalar dentro de uma instância de gateway

    1. Acesse a página Instances no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Acesse a página de detalhes da instância de destino. No painel de navegação à esquerda, selecione Plug-in.

    3. Clique em Install Plug-in. Na página Install Plugin, use o painel Quick Navigation para selecionar um tipo de plugin ou pesquisar pelo nome. Clique no cartão do plugin e, em seguida, clique em Install and Configure na caixa de diálogo exibida.

    4. Na caixa de diálogo Rule Configuration, configure as regras do plugin selecionado, defina o escopo efetivo e clique em OK.

    5. (Opcional) Na página da instância de gateway, selecione Plug-in no painel de navegação à esquerda. Na lista de plugins, localize o plugin de destino e clique em Rule Configuration na coluna Actions. Em seguida, configure as regras e selecione o escopo efetivo.

      • Se você selecionar MCP/Route Level Plugin Rules ou Domain-level plug-in rules, clique em Add Rule. Na página Add Routing Level Rule ou Add Domain Level Rule, ative o campo Status (ativado por padrão), selecione um Target, configure as Plug-in Rules e clique em OK.

      • Se você selecionar Instance-level plug-in rules, ative o campo Status (ativado por padrão), configure as Plug-in Rules e clique em Save.

    Desinstalar um plugin

    Contexto

    A desinstalação remove completamente o plugin de um gateway. Há duas formas de desinstalar plugins.

    Importante

    Antes de desinstalar um plugin, desative todas as regras ativas associadas a ele. Se o plugin não estiver ativado, a desinstalação também excluirá todas as regras configuradas.

    Método 1: Desinstalar fora de uma instância de gateway

    1. Acesse a página Plugins no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Na página Plug-in, no painel Quick Navigation, selecione um tipo de plugin ou pesquise pelo nome. Clique no cartão do plugin que deseja desinstalar.

    3. Clique na aba Configuration. Localize a instância de gateway da qual deseja remover o plugin e clique em Uninstall na coluna Actions.

    4. Na caixa de diálogo exibida, clique em OK. Uma mensagem confirmará que o plugin foi desinstalado com sucesso.

    Método 2: Desinstalar dentro de uma instância de gateway

    1. Acesse a página Instances no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Acesse a página de detalhes da instância de destino e, no painel de navegação à esquerda, selecione Plug-in.

    3. Na lista de plugins, localize o plugin que deseja remover e clique em Uninstall na coluna Actions.

    4. Na caixa de diálogo exibida, clique em OK. Uma mensagem confirmará que a desinstalação foi concluída com sucesso.

    Adicionar uma versão a um plugin personalizado

    Importante

    Não é possível adicionar versões a plugins Lua personalizados.

    Adicionar uma versão cria um novo registro para cada modificação em um plugin personalizado, facilitando o rastreamento de alterações e o controle de releases. Siga estas etapas:

    1. Acesse a página Plugins no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Na página Plug-in, no painel Quick Navigation, defina Plug-in Type como Custom ou pesquise o plugin pelo nome. Clique em Add Version no cartão do plugin. No painel Add Version, configure as Version Information:

      • Version: insira o número da versão do plugin. O número deve seguir a especificação de versionamento semântico (semver), como 1.0.1.

      • Version Description: uma breve descrição dos recursos e alterações desta versão, como Added rate limiting feature.

      • WASM File: o arquivo compilado .wasm que executa a lógica do plugin no gateway.

      • Execution Stage: selecione a fase do fluxo de processamento de requisições em que o plugin será executado, como Default Phase.

      • Execution Priority: insira um número para definir a ordem de execução do plugin. Um número maior indica prioridade mais alta.

      • Adapt to Gateway Version: insira o número da versão do mecanismo do gateway compatível com este plugin. Isso garante a execução correta do plugin.

        Nota

        Esta é a versão mínima do gateway na qual este plugin pode ser instalado.

    Alterações de versão de plugin

    Importante

    Para garantir uma atualização tranquila, certifique-se de que a nova versão seja compatível com a configuração de regras da versão original.

    1. Acesse a página Instances no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Acesse a página de detalhes da instância de destino. No painel de navegação à esquerda, selecione Plug-in.

    3. Na lista de plugins, localize o plugin desejado. Em seguida, clique em Version Change na coluna Actions.

    4. Na caixa de diálogo Version Change, selecione a versão desejada e clique em OK.

    Excluir uma versão

    1. Acesse a página Plugins no console do Cloud-native API Gateway. Na barra de menu superior, selecione uma região.

    2. Na página Plug-in, localize um plugin definindo Plug-in Type como Custom no painel Quick Navigation ou pesquisando pelo nome. Passe o mouse sobre o ícone image no cartão do plugin.

    3. Em seguida, clique em Deleted.. Na caixa de diálogo exibida, selecione a versão a ser excluída e clique em OK.