全部产品
Search

搜索本产品

    API Gateway：Kelola plugin

    文档中心

    API Gateway：Kelola plugin

    更新时间：Nov 10, 2025

    Cloud-native API Gateway menyediakan plugin ekstensi bawaan untuk fitur-fitur seperti autentikasi, pengendalian lalu lintas, dan perlindungan keamanan. Anda juga dapat mengunggah plugin kustom untuk memperluas kemampuan gerbang secara fleksibel. Topik ini menjelaskan cara menginstal, mengaktifkan, dan menguninstall plugin, serta mencakup manajemen versi plugin, pembaruan panas tanpa gangguan, serta peningkatan atau penurunan spesifikasi.

    Pengenalan plugin

    Plugin Cloud-native API Gateway dikategorikan menjadi tiga jenis berikut berdasarkan sumbernya:

    • Plugin resmi: Plugin yang dirilis oleh Higress.

    • Plugin komunitas: Plugin yang dikontribusikan oleh komunitas Higress.

    • Plugin kustom: Plugin yang Anda unggah untuk penggunaan pribadi.

    Instalasi dan aktifkan plugin

    Untuk menginstal plugin, pilih plugin tersebut di Cloud-native API Gateway dan instal pada instans gerbang. Agar plugin berlaku, Anda harus menginstalnya, mengonfigurasi aturannya, dan mengaktifkannya. Cloud-native API Gateway menyediakan dua metode untuk menginstal plugin:

    Catatan

    • MCP/Routing-level Plugin Rules: Aturan ini berlaku untuk entri rute dan diterapkan ketika permintaan cocok dengan entri rute tertentu.

    • Domain-level Plugin Rules: Aturan ini berlaku untuk nama domain. Aturan untuk nama domain tertentu memiliki prioritas lebih tinggi daripada aturan untuk nama domain wildcard.

    • Instance-level Plugin Rules: Aturan ini berlaku secara global untuk gerbang dan digunakan jika tidak ada aturan tingkat entri rute atau tingkat domain yang cocok.

    Metode 1: Instal dari luar instans gerbang

    1. Buka halaman Plugins di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Di halaman Plugins, gunakan bagian Quick Navigation untuk memilih jenis plugin atau mencari plugin berdasarkan nama. Klik Install pada kartu plugin. Di kotak dialog Install Plugin, pilih instans gerbang target, lalu klik OK.

    3. Di bagian Configuration, temukan instans gerbang target dan klik Configure Rules di kolom Actions. Di halaman konfigurasi aturan, pilih Scope.

      • Jika Anda memilih MCP/Routing-level Plugin Rules atau Domain-level Plugin Rules, klik Add Rule. Di halaman Add Routing Level Rule atau Add Domain Level Rule, aktifkan sakelar Enable Status (aktif secara default), pilih Target, konfigurasi Plugin Rules, lalu klik OK.

      • Jika Anda memilih Instance-level Plugin Rules, aktifkan sakelar Enable Status (aktif secara default), konfigurasi Plugin Rules, lalu klik Save.

    Metode 2: Instal dari dalam instans gerbang

    1. Buka halaman Instances di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Buka halaman detail instans target. Di panel navigasi sebelah kiri, klik Plugins.

    3. Klik Install Plugin. Di halaman Install Plugin, gunakan bagian Quick Navigation untuk memilih jenis plugin atau mencari plugin berdasarkan nama. Klik kartu plugin. Di kotak dialog, klik Install And Configure.

    4. Di kotak dialog Configure Rules, konfigurasikan aturan untuk plugin yang dipilih dan pilih cakupan. Klik OK.

    5. (Opsional) Di halaman instans gerbang, pilih Plugins di panel navigasi sebelah kiri. Di daftar plugin, klik Configure Rules di kolom Actions untuk plugin yang diinginkan guna mengonfigurasi aturan dan cakupannya.

      • Jika Anda memilih MCP/Routing-level Plugin Rules atau Domain-level Plugin Rules, klik Add Rule. Di halaman Add Routing Level Rule atau Add Domain Level Rule, aktifkan sakelar Enable Status (aktif secara default), pilih Target, konfigurasi Plugin Rules, lalu klik OK.

      • Jika Anda memilih Instance-level Plugin Rules, aktifkan sakelar Enable Status (aktif secara default), konfigurasi Plugin Rules, lalu klik Save.

    Uninstall plugin

    Latar Belakang

    Jika Anda tidak lagi memerlukan plugin pada gerbang, Anda dapat menguninstall-nya untuk menghapusnya secara permanen. Cloud-native API Gateway menyediakan dua metode untuk menguninstall plugin:

    Penting

    Sebelum menguninstall plugin yang memiliki aturan yang diaktifkan, Anda harus menonaktifkannya terlebih dahulu. Jika plugin tidak diaktifkan, menguninstall-nya juga akan menghapus semua aturan yang telah dikonfigurasi.

    Metode 1: Uninstall dari luar instans gerbang

    1. Buka halaman Plugins di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Di halaman Plugins, gunakan bagian Quick Navigation untuk memilih jenis plugin atau mencari plugin berdasarkan nama. Klik kartu plugin yang ingin Anda uninstall.

    3. Klik tab Configuration. Temukan instans gerbang tempat Anda ingin menguninstall plugin, lalu klik Uninstall di kolom Actions.

    4. Di kotak dialog konfirmasi, klik OK. Pesan keberhasilan akan ditampilkan.

    Metode 2: Uninstall dari dalam instans gerbang

    1. Buka halaman Instances di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Buka halaman detail instans target. Di panel navigasi sebelah kiri, klik Plugins.

    3. Di daftar plugin, temukan plugin yang ingin Anda uninstall dan klik Uninstall di kolom Actions.

    4. Di kotak dialog konfirmasi, klik OK. Pesan keberhasilan akan ditampilkan.

    Tambahkan versi ke plugin kustom

    Penting

    Plugin kustom Lua merupakan pengecualian dan tidak mendukung pengendalian versi.

    Menambahkan versi membuat catatan versi baru untuk setiap modifikasi pada plugin kustom. Hal ini memungkinkan Anda mengelola perubahan, melacak riwayat, dan mengontrol rilis. Ikuti langkah-langkah berikut:

    1. Buka halaman Plugins di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Di halaman Plugins, gunakan bagian Quick Navigation untuk mengatur Plugin Type menjadi Custom atau cari plugin berdasarkan nama. Klik Add Version pada kartu plugin. Di panel Add Version, konfigurasi Version Information:

      • Version Number: Masukkan identifikasi versi untuk plugin. Nomor versi harus mematuhi spesifikasi Semantic Versioning (SemVer), misalnya 1.0.1.

      • Version Description: Masukkan deskripsi singkat mengenai fitur atau perubahan pada versi ini, misalnya Added rate limiting feature.

      • WASM File: Unggah file .wasm yang telah dikompilasi yang mengeksekusi logika plugin di gerbang.

      • Execution Phase: Pilih fase dalam alur pemrosesan permintaan saat plugin dijalankan, misalnya Default Phase.

      • Execution Priority: Masukkan angka untuk menentukan urutan eksekusi plugin. Angka yang lebih besar menunjukkan prioritas yang lebih tinggi.

      • Compatible Gateway Version: Masukkan nomor versi mesin gerbang yang kompatibel dengan plugin ini untuk memastikan plugin berjalan dengan benar.

        Catatan

        Versi gerbang minimum tempat plugin ini dapat diinstal.

    Ubah versi plugin

    Penting

    Untuk memastikan peningkatan berjalan lancar, pastikan versi baru kompatibel dengan konfigurasi aturan versi saat ini.

    1. Buka halaman Instances di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Buka halaman detail instans target. Di panel navigasi sebelah kiri, klik Plugins.

    3. Di daftar plugin, temukan plugin target dan klik Change Version di kolom Actions.

    4. Di kotak dialog Change Version, pilih versi target, lalu klik OK.

    Hapus versi

    1. Buka halaman Plugins di Konsol Cloud-native API Gateway. Di bilah menu atas, pilih Wilayah.

    2. Di halaman Plugins, gunakan bagian Quick Navigation untuk mengatur Plugin Type menjadi Custom atau cari plugin berdasarkan nama. Di kartu plugin, arahkan penunjuk tetikus ke ikon image.

    3. Klik Delete Plugin, pilih versi yang ingin Anda hapus, lalu klik OK.