全部产品
Search
文档中心

API Gateway:Konfigurasikan kebijakan dan plugin

更新时间:Dec 18, 2025

API Gateway cloud-native mendukung penambahan kebijakan dan konfigurasi plugin untuk API dan operasi API guna meningkatkan keamanan, kinerja, serta kemudahan pemeliharaannya.

Penting
  • Konfigurasi kebijakan langsung berlaku tanpa perlu menerbitkan ulang API.

  • Secara default, konfigurasi plugin tingkat API diterapkan pada tingkat operasi.

  • Meskipun kebijakan tingkat API tidak dapat dihapus pada tingkat operasi, kebijakan tingkat operasi dapat menimpa kebijakan tingkat API.

Prosedur

  1. API Gateway cloud-native menyediakan dua cara untuk menambahkan kebijakan API: di luar instans dan di dalam instans:

    API di luar instans

    1. Login ke Konsol API Gateway cloud-native. Pada panel navigasi sebelah kiri, pilih API, lalu pilih wilayah di bilah menu atas.

    2. Klik API yang dituju, lalu Anda dapat memilih instans tempat Anda ingin menambahkan kebijakan dari daftar dropdown.image

    API di dalam instans

    1. Login ke Konsol API Gateway cloud-native. Pada panel navigasi sebelah kiri, pilih Instance, lalu pilih wilayah di bilah menu atas.

    2. Pada halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

  2. Anda dapat mengonfigurasi kebijakan dan plugin pada tingkat API atau tingkat operasi:

    • Tingkat API: Klik tab Policy Configuration untuk mengonfigurasi kebijakan dan plugin tingkat API untuk semua operasi, lalu klik Enable Policy/Plug-in.

    • Tingkat operasi: Pada daftar operasi, klik operasi yang dituju, klik tab Policy Configuration, lalu klik Enable Policy/Plug-in.

  3. Pada panel Enable Policy/Plug-in, pilih kebijakan atau plugin yang akan dikonfigurasi. Untuk informasi selengkapnya, lihat Konfigurasi kebijakan dan Konfigurasi plugin.

Konfigurasi kebijakan

Kebijakan pembatasan kecepatan

API Gateway cloud-native mendukung penerapan kebijakan pembatasan kecepatan pada tingkat API dan operasi untuk secara efektif mencegah permintaan eksternal melebihi kapasitas layanan backend dan menghindari kegagalan berantai. Fitur pembatasan kecepatan membantu Anda memblokir sebagian permintaan ketika jumlah permintaan konkuren besar, sehingga memastikan ketersediaan layanan backend. Anda dapat mengontrol secara tepat jumlah permintaan untuk setiap API dan operasi dalam periode waktu tertentu agar tidak melebihi ambang batas yang telah ditetapkan.

Kebijakan pembatasan kecepatan mencakup kebijakan Kontrol Konkurensi, Pembentukan Trafik, dan Pemutusan Sirkuit.

  • Kebijakan kontrol konkurensi: Aturan konkurensi bekerja dengan menghitung jumlah total permintaan yang sedang diproses oleh gateway. Ketika metrik mencapai ambang batas yang ditetapkan, trafik segera diblokir. Anda dapat mengonfigurasi jumlah maksimum permintaan konkuren yang dapat diproses oleh layanan backend untuk melindungi ketersediaan layanan backend dalam kondisi konkurensi tinggi.

    Prosedur

    Pada halaman Add Policy, klik kartu Concurrency Control. Pada panel Add Policy: Concurrency Control, konfigurasikan parameter berikut.

    Parameter

    Deskripsi

    Enable

    Jika Anda mengaktifkan sakelar ini, aturan konkurensi akan berlaku.

    Overall Concurrency Threshold

    Tetapkan Overall Concurrency Threshold.

    Web Fallback Behavior

    Return Specified Content

    HTTP Status Code

    Tetapkan HTTP Status Code. Nilai default-nya adalah 429.

    Return Content-type

    Pilih Plain Text atau JSON sebagai Return Content-type.

    HTTP Return Text

    Masukkan teks yang dikembalikan.

    Return Specified Content

    Redirect URL

    Masukkan Redirect URL.

  • Kebijakan pembentukan trafik: Aturan kontrol trafik bekerja dengan memantau metrik QPS API dan operasi. Ketika metrik mencapai ambang batas yang ditetapkan, trafik segera diblokir untuk mencegah layanan backend kewalahan akibat lonjakan trafik mendadak, sehingga memastikan ketersediaan tinggi.

    Prosedur

    Pada halaman Add Policy, klik kartu Traffic Control. Pada panel Add Policy: Traffic Control, konfigurasikan parameter berikut.

    Parameter

    Deskripsi

    Enable

    Jika Anda mengaktifkan sakelar ini, kebijakan kontrol trafik akan berlaku.

    Overall QPS Threshold

    Tetapkan Overall QPS Threshold.

    Web Fallback Behavior

    Return Specified Content

    HTTP Status Code

    Tetapkan HTTP Status Code. Nilai default-nya adalah 429.

    Return Content-type

    Pilih Plain Text atau JSON sebagai Return Content-type.

    HTTP Return Text

    Masukkan teks yang dikembalikan.

    Redirect To Specified Page

    Redirect URL

    Masukkan Redirect URL.

  • Kebijakan pemutusan sirkuit: Aturan pemutusan sirkuit bekerja dengan memantau waktu respons atau laju kesalahan API dan operasi. Ketika ambang batas yang ditentukan tercapai, prioritas dependensi segera diturunkan. Jika pemutusan sirkuit dipicu, sistem tidak memanggil permintaan pada rute tersebut dalam periode waktu tertentu, sehingga memastikan ketersediaan tinggi layanan backend. Setelah periode waktu tersebut berakhir, sistem melanjutkan pemanggilan permintaan pada rute tersebut.

    Prosedur

    Pada halaman Add Policy, klik kartu Circuit Breaking. Pada panel Add Policy: Circuit Breaking, konfigurasikan parameter berikut.

    Parameter

    Deskripsi

    Enable

    Jika Anda mengaktifkan sakelar ini, aturan pembatasan kecepatan yang dikonfigurasi akan berlaku.

    Statistics Window Duration

    Panjang jendela waktu. Rentang nilai yang valid adalah 1 detik hingga 120 menit.

    Minimum Number Of Requests

    Jumlah minimum permintaan untuk memicu pemutusan sirkuit. Jika jumlah permintaan dalam jendela waktu saat ini kurang dari nilai parameter ini, pemutusan sirkuit tidak dipicu meskipun aturan pemutusan sirkuit terpenuhi.

    Threshold Type

    Pilih Slow Call Percentage (%) atau Error Percentage (%) sebagai ambang batas.

    1. Jika Anda memilih Slow Call Percentage (%) sebagai ambang batas, Anda perlu menetapkan Slow Call RT (waktu respons maksimum) yang diizinkan. Permintaan dengan waktu respons lebih besar dari nilai ini dihitung sebagai panggilan lambat. Tetapkan ambang batas Downgrade sebagai persentase panggilan lambat. Setelah aturan pemutusan sirkuit diaktifkan, jika jumlah permintaan yang diajukan dalam periode waktu tertentu lebih besar dari jumlah minimum permintaan yang ditentukan dan persentase panggilan lambat melebihi ambang batas yang ditentukan, pemutusan sirkuit secara otomatis diterapkan pada permintaan yang diproses dalam periode pemutusan sirkuit berikutnya. Setelah periode pemutusan sirkuit berakhir, pemutus sirkuit mulai mendeteksi RT permintaan berikutnya. Jika RT permintaan berikutnya kurang dari nilai parameter Slow Call RT, pemutusan sirkuit berakhir. Jika RT permintaan berikutnya lebih besar dari nilai parameter Slow Call RT, pemutusan sirkuit dipicu kembali.

    2. Jika Anda memilih Error Percentage (%) sebagai ambang batas, Anda perlu menetapkan ambang batas Downgrade sebagai persentase kesalahan. Setelah aturan diaktifkan, jika jumlah permintaan yang gagal dalam periode waktu tertentu lebih besar dari jumlah minimum permintaan yang ditentukan dan persentase permintaan yang gagal melebihi ambang batas yang ditentukan, pemutusan sirkuit secara otomatis diterapkan pada permintaan yang diproses dalam periode pemutusan sirkuit berikutnya.

    Slow Call RT

    Tetapkan Slow Call RT (waktu respons maksimum) yang diizinkan.

    Circuit Breaking Threshold

    Ambang batas persentase untuk panggilan lambat. Jika ambang batas yang ditentukan tercapai atau dilampaui, pemutusan sirkuit dipicu. Nilai yang valid: 0–100. Nilai ini merepresentasikan 0% hingga 100%.

    Circuit Breaking Duration (s)

    Periode penerapan pemutusan sirkuit. Jika pemutusan sirkuit diterapkan pada sumber daya, semua pemanggilan ke sumber daya tersebut akan gagal selama durasi yang dikonfigurasi.

    Web Fallback Behavior

    Return Specified Content

    HTTP Status Code

    Tetapkan HTTP Status Code. Nilai default-nya adalah 429.

    Return Content-type

    Pilih Plain Text atau JSON sebagai Return Content-type.

    HTTP Return Text

    Masukkan teks yang dikembalikan.

    Redirect To Specified Page

    Redirect URL

    Masukkan Redirect URL.

Kebijakan penulisan ulang

Anda dapat mengonfigurasi kebijakan penulisan ulang untuk secara fleksibel mengubah path dan hostname dalam permintaan sebelum diteruskan ke layanan backend tujuan, sesuai kebutuhan lingkungan bisnis dan arsitektur tertentu. Kebijakan ini memungkinkan Anda mengontrol secara tepat path dan hostname permintaan agar diarahkan dengan benar ke layanan atau titik akhir yang sesuai.

Prosedur

Pada halaman Add Policy, klik HTTP Rewrite untuk masuk ke panel Add Policy: HTTP Rewrite dan konfigurasikan parameter berikut.

  • Penulisan ulang path

    Untuk penulisan ulang path, gateway API cloud-native mendukung dua metode penulisan ulang berikut.

    • Exact Rewrite: Hanya mendukung penulisan ulang tingkat operasi.

    • Regex Rewrite: Mendukung penulisan ulang tingkat operasi maupun tingkat API.

    Exact rewrite

    Metode exact rewrite mengubah awalan path dalam permintaan.

    Contoh 1

    Path dalam permintaan asli adalah /app/test, tetapi path dalam permintaan yang diteruskan ke layanan backend adalah /test. Kami menyarankan Anda mengonfigurasi kebijakan penulisan ulang berikut:

    • Kondisi pencocokan API dan operasi: Metode pencocokan adalah exact match, dan path-nya adalah /app/.

    • Penulisan ulang: Metode penulisan ulang adalah exact rewrite, dan path-nya adalah /.

    Catatan

    Path dalam kondisi pencocokan API dan operasi harus diatur ke /app/ karena metode exact rewrite hanya memodifikasi string yang cocok secara eksak. Jika path dalam kondisi pencocokan API dan operasi diatur ke /app, path setelah penulisan ulang akan menjadi //test, yang tidak sesuai harapan.

    Contoh 2

    Path dalam permintaan asli adalah /v1/test, tetapi path dalam permintaan yang diteruskan ke layanan backend adalah /v2/test. Kami menyarankan Anda mengonfigurasi pengaturan berikut:

    • Kondisi pencocokan API dan operasi: Metode pencocokan adalah exact match, dan path-nya adalah /v1.

    • Penulisan ulang: Metode penulisan ulang adalah exact rewrite, dan path-nya adalah /v2.

    Penting

    Metode exact rewrite mengharuskan metode pencocokan API dan operasi menggunakan exact match. Prefix match dan regex match tidak mendukung metode exact rewrite. Karena metode pencocokan API dan operasi menggunakan exact match dan dapat mencocokkan semua permintaan dengan awalan path tertentu, Anda perlu mempertimbangkan apakah ingin menulis ulang semua permintaan tersebut saat mengonfigurasi kebijakan exact rewrite. Jika tidak, kami menyarankan Anda menggunakan metode exact rewrite.

    Regex rewrite

    Metode ini secara parsial mengubah path dalam permintaan. Konfigurasi regex rewrite terdiri dari bidang mode dan replacement. Nilai bidang mode digunakan untuk mencocokkan bagian tertentu yang ingin Anda ubah dalam path asli, sedangkan nilai bidang replacement digunakan untuk menggantikan bagian yang cocok. Untuk informasi lebih lanjut mengenai sintaks ekspresi reguler, lihat Regular Expression Syntax.

    Contoh 1

    Path dalam permintaan asli adalah /aaa/one/bbb/one/ccc, tetapi path dalam permintaan yang diteruskan ke layanan backend adalah /aaa/two/bbb/two/ccc. Kami menyarankan Anda mengonfigurasi pengaturan berikut:

    • Kondisi pencocokan API dan operasi: Metode pencocokan adalah exact match, dan path-nya adalah /aaa/one/bbb/one/ccc.

    • Penulisan ulang: Metode penulisan ulang adalah regex rewrite, mode-nya adalah one, dan replacement-nya adalah two.

    Contoh 2

    Path dalam permintaan asli adalah /httpbin/(.*)/(.*). Anda ingin menghapus awalan /httpbin dan menukar posisi kedua bagian ekspresi reguler tersebut. Kami menyarankan Anda mengonfigurasi pengaturan berikut:

    • Kondisi pencocokan API dan operasi: Metode pencocokan adalah regex match, dan path-nya adalah /httpbin/(.*)/(.*).

    • Penulisan ulang: Metode penulisan ulang adalah regex rewrite, mode-nya adalah /httpbin/(.*)/(.*), dan replacement-nya adalah /\2/\1. \1 merepresentasikan string pertama yang dicocokkan oleh ekspresi reguler, dan \2 merepresentasikan string kedua yang dicocokkan oleh ekspresi reguler, yang sesuai dengan penggunaan $1 dan $2 di Nginx.

    Contoh 3

    Untuk REST API dengan manajemen versi yang diaktifkan dan menggunakan metode path, Anda ingin menghapus field versi dari path permintaan saat diteruskan ke backend. Misalnya, path permintaan asli adalah /basePath/version/order/get, tetapi path yang diteruskan ke layanan backend adalah /basePath/order/get. Kami menyarankan Anda mengonfigurasi pengaturan berikut:

    • Pilih Use API Policy Configuration

    • Penulisan ulang: Metode penulisan ulang adalah regex rewrite, mode-nya adalah (/.*)/version(/.*), dan replacement-nya adalah \1\2. \1 merepresentasikan string pertama yang dicocokkan oleh ekspresi reguler, dan \2 merepresentasikan string kedua yang dicocokkan oleh ekspresi reguler, yang sesuai dengan penggunaan $1 dan $2 di Nginx.

    Catatan

    Metode regex rewrite lebih kompleks dibandingkan metode prefix rewrite dan exact rewrite. Kami menyarankan Anda menggunakan metode exact rewrite.

  • Penulisan ulang hostname

    Gateway API cloud-native memungkinkan Anda memodifikasi hostname dalam permintaan menggunakan metode exact rewrite.

    Misalnya, hostname dalam permintaan asli adalah test.com, tetapi hostname dalam permintaan yang diteruskan ke layanan backend adalah dev.com. Dalam kebijakan penulisan ulang, atur hostname penulisan ulang menjadi dev.com.

Kebijakan pengaturan header

Anda dapat mengonfigurasi kebijakan pengaturan header untuk memodifikasi header dalam permintaan atau respons sebelum permintaan diteruskan ke layanan backend tujuan atau sebelum respons layanan backend dikembalikan ke klien.

Prosedur

Pada halaman Add Policy, klik kartu Header Modification. Pada panel Add Policy: Header Modification, konfigurasikan parameter berikut.

Parameter

Deskripsi

Enable

Menentukan apakah kebijakan pengaturan header diaktifkan.

  • Jika Anda mengaktifkan kebijakan pengaturan header, gateway mengontrol header dalam permintaan atau respons.

  • Jika Anda menonaktifkan kebijakan pengaturan header, gateway tidak mengontrol header dalam permintaan atau respons.

Header Type

Pilih tipe header.

  • Request: Header dalam permintaan diatur.

  • Response: Header dalam respons diatur.

Action Type

Pilih tipe aksi.

  • Add: Header ditambahkan ke permintaan atau respons.

    Catatan

    Jika header yang ditentukan sudah ada dalam permintaan atau respons, nilai header yang ditentukan dalam aturan ini akan digabungkan dengan nilai header yang sudah ada. Nilainya dipisahkan dengan koma (,).

  • Modify: Header yang ditentukan dalam permintaan atau respons dimodifikasi.

    Catatan

    • Jika header yang ditentukan tidak ada dalam permintaan atau respons, header tersebut akan ditambahkan ke permintaan atau respons berdasarkan kunci dan nilai header yang ditentukan dalam aturan ini.

    • Jika header yang ditentukan sudah ada, nilainya akan diganti dengan nilai header yang ditentukan dalam aturan ini.

  • Delete: Header yang ditentukan dalam permintaan atau respons dihapus.

Header Key

Masukkan kunci header.

Header Value

Masukkan nilai header.

Kebijakan berbagi sumber daya lintas-origin

CORS merupakan kebijakan keamanan penting yang memungkinkan server aplikasi web melakukan kontrol akses lintas-origin untuk menerapkan transfer data yang aman. API Gateway cloud-native mendukung konfigurasi kebijakan CORS pada tingkat API dan operasi. Anda dapat membatasi nama domain dan metode permintaan yang diizinkan untuk mengakses sumber daya sesuai kebutuhan bisnis Anda.

Penting

Kebijakan CORS tidak berlaku untuk layanan mock. Anda harus mengonfigurasi layanan uji backend yang sebenarnya.

Prosedur

Pada halaman Add Policy, klik kartu CORS. Pada panel Add Policy: CORS, konfigurasikan parameter berikut.

Parameter

Deskripsi

Enable

Aktifkan sakelar di sebelah kanan Enable.

  • Jika Anda mengaktifkan kebijakan, permintaan CORS diizinkan.

  • Jika Anda menonaktifkan kebijakan, semua permintaan CORS ditolak.

Allowed Origins

Origin yang diizinkan mengakses sumber daya di server saat ini melalui browser. Format:

  • Untuk mengizinkan semua origin: *.

  • Untuk mengizinkan origin dengan nama domain root tertentu: *.example.com.

  • Untuk mengizinkan beberapa origin spesifik: Masukkan origin yang dimulai dengan http:// atau https://. Masukkan setiap origin pada baris terpisah.

Catatan

Parameter ini digunakan untuk header Access-Control-Allow-Origin. Ketika header Origin dalam permintaan klien cocok dengan salah satu origin yang diizinkan yang Anda tentukan, header Access-Control-Allow-Origin dalam respons CORS diatur ke header Origin dalam permintaan klien.

Allowed Methods

Metode HTTP yang diizinkan untuk permintaan CORS. Metode umum meliputi GET, POST, PUT, DELETE, HEAD, OPTIONS, dan PATCH.

Catatan

Parameter ini digunakan untuk header Access-Control-Allow-Methods.

Allowed Request Headers

Header tambahan yang diizinkan dalam permintaan CORS selain header bawaan browser. Format:

  • Untuk mengizinkan semua header permintaan: *.

  • Untuk menentukan beberapa header permintaan, masukkan setiap header permintaan pada baris terpisah.

Catatan

Parameter ini digunakan untuk header Access-Control-Allow-Headers.

Allowed Response Headers

Header respons yang dapat diperoleh oleh browser dan file JavaScript. Format:

  • Untuk mengizinkan semua header respons: *.

  • Untuk menentukan beberapa header respons, masukkan setiap header respons pada baris terpisah.

Catatan

Parameter ini digunakan untuk header Access-Control-Expose-Headers.

Allow Credentials

Menentukan apakah kredensial diizinkan dalam permintaan CORS.

Catatan

Parameter ini digunakan untuk header Access-Control-Allow-Credentials.

Max Age Of Preflight Request

Periode waktu maksimum caching untuk permintaan preflight yang menggunakan metode OPTIONS.

Catatan

Parameter ini digunakan untuk header Access-Control-Max-Age.

Kebijakan replikasi trafik

Kebijakan replikasi trafik memungkinkan Anda mereplikasi trafik aplikasi online ke layanan tertentu. Fitur ini memberikan dukungan untuk simulasi pengujian dan pelokalisiran kesalahan pada sistem serta membantu Anda mengevaluasi kinerja aplikasi dan memecahkan masalah secara efisien.

Prosedur

Pada halaman Add Policy, klik kartu Traffic Replication. Pada panel Add Policy: Traffic Replication, konfigurasikan parameter berikut.

Parameter

Deskripsi

Enable

Sakelar yang mengaktifkan atau menonaktifkan kebijakan replikasi trafik untuk API atau operasi.

Destination Service

Layanan tujuan tempat Anda ingin meneruskan trafik yang direplikasi.

Catatan

Hanya layanan berbasis HTTP atau HTTPS yang didukung.

Port

Port layanan tujuan. Anda dapat memilih Dynamic Port.

Catatan

Dynamic Port cocok untuk skenario di mana port layanan berubah secara dinamis. Anda tidak dapat memilih Dynamic Port untuk layanan multi-port.

Traffic Replication Percentage (%)

Persentase replikasi trafik. Nilai yang valid: 0 hingga 100.

Catatan

Jika Anda mengatur parameter ini ke 50, 50% trafik untuk API dan operasi saat ini direplikasi ke layanan tujuan.

Kebijakan timeout

API Gateway cloud-native menyediakan pengaturan timeout pada tingkat API dan operasi. Anda dapat mengonfigurasi periode waktu maksimum yang digunakan gateway untuk menunggu respons terhadap permintaan untuk API dan operasi tertentu. Jika gateway tidak menerima respons dari layanan backend dalam periode waktu yang ditentukan, gateway mengembalikan kode status HTTP 504 (Gateway Timeout) ke klien.

Prosedur

Pada halaman Add Policy, klik kartu Timeout. Pada panel Add Policy: Timeout, konfigurasikan parameter berikut.

Catatan

Setelah kebijakan timeout dibuat dan diaktifkan, Anda dapat memeriksa apakah kebijakan timeout berlaku sesuai kebutuhan bisnis Anda.

Parameter

Deskripsi

Enable

Menentukan apakah kebijakan timeout diaktifkan.

  • Aktifkan: Kebijakan timeout untuk API atau operasi di gateway berlaku.

  • Nonaktifkan: Kebijakan timeout untuk API atau operasi di gateway tidak berlaku.

Timeout Period

Durasi timeout untuk API dan operasi saat ini. Satuan: detik.

Catatan

Jika Anda mengatur parameter ini ke 0 atau menonaktifkan kebijakan timeout, gateway akan menunggu respons selamanya.

Kebijakan coba lagi

API Gateway cloud-native menyediakan pengaturan retry pada tingkat API dan operasi untuk secara otomatis mencoba ulang permintaan yang gagal. Anda dapat mengonfigurasi kondisi retry, seperti koneksi gagal, layanan backend tidak tersedia, atau respons dengan kode status HTTP tertentu.

Kondisi retry untuk API dan operasi

Ketika layanan backend mengembalikan kesalahan 5xx, API Gateway cloud-native secara otomatis mencoba ulang permintaan yang gagal berdasarkan jumlah retry yang dikonfigurasi.

image
  • Kondisi retry untuk HTTP Protocol adalah sebagai berikut:

    • 5xx: Jika layanan backend mengembalikan respons 5xx apa pun, atau jika koneksi terputus atau di-reset, atau jika terjadi timeout baca, API Gateway cloud-native mencoba melakukan retry terhadap permintaan yang gagal.

      Catatan

      5xx mencakup kondisi connect-failure dan refused-stream.

    • reset: Jika koneksi terputus atau di-reset, atau jika terjadi timeout baca, API Gateway cloud-native mencoba melakukan retry terhadap permintaan yang gagal.

    • connect-failure: Jika permintaan gagal karena koneksi terputus, API Gateway cloud-native mencoba melakukan retry terhadap permintaan yang gagal.

    • refused-stream: Jika layanan backend mereset aliran dengan kode kesalahan REFUSED_STREAM, API Gateway cloud-native mencoba melakukan retry terhadap permintaan yang gagal.

    • retriable-status-codes: Jika kode status HTTP dalam respons dari layanan backend cocok dengan kode status retry yang Anda tentukan, API Gateway cloud-native mencoba melakukan retry terhadap permintaan tersebut.

      Catatan

      Anda hanya dapat menggunakan kode status retry jika Anda menentukan retriable-status-codes dalam kondisi retry.

  • Kondisi retry untuk GRPC Protocol adalah sebagai berikut:

    • cancelled: Jika kode status gRPC dalam header respons dari layanan gRPC backend adalah cancelled, API Gateway cloud-native mencoba melakukan retry terhadap permintaan tersebut.

    • deadline-exceeded: Jika kode status gRPC dalam header respons dari layanan gRPC backend adalah deadline-exceeded, API Gateway cloud-native mencoba melakukan retry terhadap permintaan tersebut.

    • internal: Jika kode status gRPC dalam header respons dari layanan gRPC backend adalah internal, API Gateway cloud-native mencoba melakukan retry terhadap permintaan tersebut.

    • resource-exhausted: Jika kode status gRPC dalam header respons dari layanan gRPC backend adalah resource-exhausted, API Gateway cloud-native mencoba melakukan retry terhadap permintaan tersebut.

    • unavailable: Jika kode status gRPC dalam header respons dari layanan gRPC backend adalah unavailable, API Gateway cloud-native mencoba melakukan retry terhadap permintaan tersebut.

Prosedur

Pada halaman Add Policy, klik kartu Retry. Pada panel Add Policy: Retry, konfigurasikan parameter berikut.

Catatan

Setelah kebijakan retry dibuat dan diaktifkan, Anda dapat memverifikasi hasilnya sesuai kebutuhan bisnis Anda.

Parameter

Deskripsi

Enable

Menentukan apakah kebijakan retry diaktifkan.

  • Aktifkan: Kebijakan retry untuk API atau operasi di gateway berlaku.

  • Nonaktifkan: Kebijakan retry untuk API atau operasi di gateway tidak berlaku.

    Setelah kebijakan retry dinonaktifkan, gateway menggunakan konfigurasi retry default. Jumlah retry default adalah 2, dan kondisi retry default adalah connect-failure, refused-stream, unavailable, cancelled, dan retriable-status-codes.

Retry Times

Jumlah maksimum retry untuk permintaan yang gagal. Anda dapat mengatur parameter ini ke bilangan bulat antara 0 hingga 10. Kami menyarankan Anda mengatur parameter ini ke 0, 1, atau 2.

Jika Anda mengatur parameter ini ke 0, permintaan yang gagal tidak akan di-retry.

Retry Condition

Pilih kondisi yang sesuai. Anda dapat memilih beberapa kondisi.

Retry Status Code

Kode status HTTP yang ingin Anda retry. Anda dapat mengonfigurasi beberapa kode status HTTP.

Penting

Anda hanya dapat mengonfigurasi Retry Status Code jika Anda menentukan retriable-status-codes untuk Retry Condition.

Konfigurasi plugin

  1. Klik tab Add Plug-in.

  2. Pada bagian Quick Navigation, pilih tipe plugin yang ingin Anda instal atau cari nama plugin, lalu klik kartu plugin tersebut:

    • Jika plugin belum diinstal, klik Install and Configure pada popup instalasi, konfigurasikan aturan plugin di panel, lalu aktifkan.

    • Jika plugin sudah diinstal, konfigurasikan aturan plugin dan aktifkan.

  3. Klik OK untuk kembali ke daftar API, tempat Anda dapat melihat status pemasangan dan pengaktifan plugin.

    image