All Products
Search

This Product

    API Gateway:Manage plugins

    Document Center

    API Gateway:Manage plugins

    Last Updated:Jun 23, 2026

    Cloud-native API Gateway menyediakan plugin bawaan untuk autentikasi, pengendalian lalu lintas, dan perlindungan keamanan, serta mendukung plugin kustom untuk ekstensi gerbang yang fleksibel. Anda dapat menginstal, mengaktifkan, menguninstall, dan mengelola versi plugin, termasuk pembaruan bergulir (rolling update), upgrade, dan downgrade yang mulus.

    Pengenalan plugin

    Plugin Cloud-native API Gateway dikelompokkan menjadi tiga kategori berdasarkan sumbernya:

    • Plugin resmi: Plugin yang dirilis oleh tim Higress.

    • Plugin komunitas: Plugin yang dikontribusikan oleh komunitas Higress.

    • Plugin kustom: Plugin yang diunggah oleh pengguna untuk keperluan pribadi.

    Instal dan aktifkan plugin

    Untuk menggunakan plugin, pilih plugin tersebut di Konsol Cloud-native API Gateway dan instal pada instans gateway. Plugin hanya berlaku setelah Anda menginstalnya, mengonfigurasi aturannya, dan mengaktifkannya. Anda dapat menginstal plugin dengan dua cara:

    Catatan

    • MCP/Route Level Plugin Rules: Aturan ini berlaku untuk entri rute dan diterapkan ketika permintaan sesuai dengan rute tertentu.

    • Domain-level plug-in rules: Aturan ini berlaku untuk nama domain. Aturan untuk nama domain spesifik memiliki prioritas lebih tinggi daripada aturan untuk nama domain wildcard.

    • Instance-level plug-in rules: Aturan ini berlaku secara global untuk gateway dan digunakan jika tidak ada aturan tingkat rute atau tingkat domain yang cocok.

    Metode 1: Instal dari luar instans gateway

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

    2. Di halaman Plug-in, pada panel Quick Navigation, pilih jenis plugin atau cari plugin berdasarkan nama. Klik Install failed. pada kartu plugin tersebut. Di kotak dialog Install Plug-in, pilih instans gateway untuk plugin tersebut, lalu klik OK.

    3. Di bagian Configuration, temukan instans gateway target dan klik Rule Configuration di kolom Actions. Di halaman konfigurasi aturan, pilih Effective Scope.

      • Jika Anda memilih MCP/Route Level Plugin Rules atau Domain-level plug-in rules, klik Add Rule. Di halaman Add Routing Level Rule atau Add Domain Level Rule, aktifkan Status (secara default sudah diaktifkan). Pilih Target, konfigurasikan Plug-in Rules, lalu klik OK.

      • Jika Anda memilih Instance-level plug-in rules, aktifkan Status (secara default sudah diaktifkan), konfigurasikan Plug-in Rules, lalu klik Save.

    Metode 2: Instal dari dalam instans gateway

    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, pilih Plug-in.

    3. Klik Install Plug-in. Di halaman Install Plugin, gunakan panel Quick Navigation untuk memilih jenis plugin atau mencari plugin berdasarkan nama. Klik kartu plugin tersebut, lalu klik Install and Configure di kotak dialog yang muncul.

    4. Di kotak dialog Rule Configuration, konfigurasikan aturan untuk plugin yang dipilih, pilih cakupan efektif, lalu klik OK.

    5. (Opsional) Di halaman instans gateway, pilih Plug-in di panel navigasi kiri. Di daftar plugin, temukan plugin target dan klik Rule Configuration di kolom Actions. Kemudian, konfigurasikan aturan dan pilih cakupan efektif.

      • Jika Anda memilih MCP/Route Level Plugin Rules atau Domain-level plug-in rules, klik Add Rule. Di halaman Add Routing Level Rule atau Add Domain Level Rule, aktifkan Status (secara default sudah diaktifkan), pilih Target, konfigurasikan Plug-in Rules, lalu klik OK.

      • Jika Anda memilih Instance-level plug-in rules, aktifkan Status (secara default sudah diaktifkan), konfigurasikan Plug-in Rules, lalu klik Save.

    Uninstall plugin

    Latar belakang

    Menguninstall plugin akan sepenuhnya menghapusnya dari gateway. Anda dapat menguninstall plugin dengan dua cara.

    Penting

    Sebelum menguninstall plugin, nonaktifkan semua aturan plugin yang aktif. Jika plugin tidak diaktifkan, proses uninstall juga akan menghapus semua aturan yang telah dikonfigurasi.

    Metode 1: Uninstall dari luar instans gateway

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

    2. Di halaman Plug-in, pada panel Quick Navigation, pilih jenis plugin atau cari plugin berdasarkan nama. Klik kartu plugin yang ingin Anda uninstall.

    3. Klik tab Configuration. Temukan instans gateway tempat Anda ingin menguninstall plugin tersebut dan klik Uninstall di kolom Actions.

    4. Di kotak dialog yang muncul, klik tombol OK. Muncul pesan konfirmasi bahwa plugin berhasil di-uninstall.

    Metode 2: Hapus instalan 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 dan di panel navigasi sebelah kiri, pilih Plug-in.

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

    4. Di kotak dialog yang muncul, klik tombol OK. Muncul pesan konfirmasi bahwa plugin berhasil di-uninstall.

    Tambahkan versi ke plugin kustom

    Penting

    Anda tidak dapat menambahkan versi ke plugin Lua kustom.

    Menambahkan versi membuat catatan versi baru untuk setiap modifikasi pada plugin kustom, membantu Anda melacak perubahan 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 Plug-in, pada panel Quick Navigation, atur Plug-in Type ke Custom atau cari plugin berdasarkan nama. Klik Add Version pada kartu plugin tersebut. Di panel Add Version, konfigurasikan Version Information:

      • Version: Masukkan nomor versi plugin. Nomor versi harus mengikuti spesifikasi semantic versioning (semver), seperti 1.0.1.

      • Version Description: Deskripsi singkat mengenai fitur dan perubahan dalam versi ini, seperti Added rate limiting feature.

      • WASM File: File .wasm terkompilasi yang menjalankan logika plugin di gateway.

      • Execution Stage: Pilih fase dalam alur pemrosesan permintaan tempat plugin dijalankan, seperti Default Phase.

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

      • Adapt to Gateway Version: Masukkan nomor versi mesin gateway yang kompatibel dengan plugin ini. Hal ini memastikan plugin berjalan dengan benar.

        Catatan

        Versi ini merupakan versi gateway minimum tempat plugin ini dapat diinstal.

    Perubahan versi plugin

    Penting

    Untuk memastikan upgrade berjalan lancar, pastikan versi baru kompatibel dengan konfigurasi aturan versi sebelumnya.

    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, pilih Plug-in.

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

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

    Hapus versi

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

    2. Di halaman Plug-in, temukan plugin dengan mengatur Plug-in Type ke Custom di panel Quick Navigation atau cari plugin berdasarkan nama. Arahkan kursor ke ikon image pada kartu plugin tersebut.

    3. Lalu klik Deleted.. Di kotak dialog yang muncul, pilih versi yang akan dihapus dan klik OK.