API Gateway：Konfigurasikan peringatan untuk API

1. Mengaitkan sumber daya

Fitur pemantauan dan peringatan API Gateway mendukung berbagai kebutuhan bisnis. Berikut adalah metrik pemantauan yang didukung:

• HttpStatusCode

• Waktu respons API

• Jumlah total permintaan untuk sebuah API

• Traffic masuk

• Traffic keluar

Berikut adalah beberapa metode untuk membuat aturan peringatan dan mengaitkannya dengan satu atau beberapa API:

• Mengaitkan aturan peringatan dengan satu API atau beberapa API dalam wilayah yang sama. Metode ini cocok jika Anda ingin mengonfigurasi aturan peringatan untuk satu API atau beberapa API dalam wilayah yang sama. Aturan peringatan tidak akan terpengaruh oleh modifikasi konfigurasi API.

• Mengaitkan aturan peringatan dengan grup API. Metode ini berguna jika Anda ingin menerapkan aturan peringatan yang sama untuk semua API dalam grup API. Jika Anda menambah, menghapus, atau memodifikasi API dalam grup tersebut, sistem akan menyinkronkan perubahan antara grup API dan aturan peringatan.

• Mengaitkan aturan peringatan dengan semua API Gateway API di akun Alibaba Cloud Anda. Metode ini cocok jika Anda hanya ingin mengelola sejumlah kecil API.

2. Konfigurasikan tingkat peringatan dan metode

CloudMonitor memungkinkan Anda mengonfigurasi tiga jenis tingkat peringatan: Kritis, Peringatan, dan Info. Metode notifikasi bervariasi berdasarkan tingkat peringatan. Untuk informasi lebih lanjut tentang notifikasi peringatan, lihat Ikhtisar.

• Kritis: Notifikasi dikirim melalui panggilan telepon, pesan teks, email, dan chatbot DingTalk. Penggunaan chatbot DingTalk memerlukan pembayaran.

• Peringatan: Notifikasi dikirim melalui pesan teks, email, dan chatbot DingTalk.

• Info: Notifikasi dikirim melalui email dan chatbot DingTalk.

3. Mengaitkan aturan peringatan dengan satu atau beberapa API

Saat mengaitkan aturan peringatan dengan satu atau beberapa API, Anda dapat mengonfigurasi template peringatan, aturan peringatan, kontak peringatan, dan notifikasi peringatan. Untuk informasi lebih lanjut, lihat Ikhtisar.

1. Masuk ke Konsol API Gateway. Di bilah navigasi atas, pilih wilayah tempat API yang ingin Anda kelola berada. Di panel navigasi kiri, pilih Manage APIs > APIs.

2. Di halaman APIs, klik nama API yang ingin Anda kelola untuk membuka halaman detail API. Di pohon navigasi kiri, klik Monitoring. Di halaman yang muncul, klik Create Alert Rules di pojok kanan atas untuk membuka halaman Aturan Peringatan di konsol CloudMonitor.

3. Di halaman Alert Rules, klik Create Alert Rule. Di panel Create Alert Rule, pilih API Gateway dari daftar drop-down Produk, pilih Instances untuk parameter Resource Range, lalu klik Add Instance. Di kotak dialog Add Instance, pilih API yang ingin Anda tambahkan.

4. Mengaitkan aturan peringatan dengan grup API

1. Untuk menerapkan aturan peringatan yang sama ke semua API dalam grup API, lakukan langkah berikut: Di panel navigasi kiri, pilih Kelola API > Grup API. Di halaman Grup API, klik grup API yang ingin Anda kelola. Di pojok kanan atas halaman Detail Grup, klik Enable CloudMonitor.

2. Saat pertama kali mengaktifkan CloudMonitor untuk grup API, kotak dialog akan muncul untuk meminta Anda membuat peran terhubung layanan untuk API Gateway. Untuk informasi lebih lanjut, lihat Peran terhubung layanan AliyunServiceRoleForApiGatewayMonitoring.

3. Klik Konfirmasi. Pesan akan muncul untuk memberi tahu bahwa CloudMonitor telah diaktifkan untuk grup API yang dipilih. Pesan tersebut mencantumkan nama grup aplikasi CloudMonitor. Grup aplikasi dibuat oleh API Gateway di konsol CloudMonitor setelah Anda memberikan izin terkait kepada API Gateway. Nama grup aplikasi memiliki format berikut: APIGATEWAY_${region}_${groupId}. Parameter ${region} menunjukkan wilayah tempat grup API berada, sedangkan ${groupId} menunjukkan ID grup API.

4. Setelah CloudMonitor diaktifkan, klik Go to CloudMonitor for Configuration di pojok kanan atas halaman Detail Grup. Di halaman yang muncul, tambahkan grup API ke bagian Layanan Cloud Terkait untuk menerapkan aturan peringatan grup aplikasi ke grup API.

5. Mengaitkan aturan peringatan dengan semua API

Langkah-langkah untuk mengaitkan aturan peringatan dengan semua API serupa dengan yang dijelaskan di "Bagian 3". Namun, Anda harus mengatur Rentang Sumber Daya ke Semua Sumber Daya. Setelah aturan peringatan dikonfigurasi untuk semua API, aturan yang sama akan berlaku untuk semua API di API Gateway di semua wilayah dalam akun Alibaba Cloud Anda. Dalam hal ini, Anda tidak dapat mengonfigurasi aturan peringatan spesifik untuk API individu. Metode ini cocok jika Anda hanya ingin mengelola sejumlah kecil API.

6. Aturan peringatan yang didukung oleh API Gateway

API Gateway memantau API dari berbagai dimensi. Anda dapat mengonfigurasi aturan peringatan berdasarkan dimensi berikut:

• Waktu respons API: Waktu respons layanan backend.

• Jumlah total permintaan untuk sebuah API: Jumlah total permintaan yang diterima API Gateway untuk API tertentu dari klien dalam periode tertentu.

• Traffic masuk: Traffic permintaan yang diterima API Gateway dari klien dalam periode tertentu.

• Traffic keluar: Traffic permintaan yang dikirim ke layanan backend dari API Gateway dalam periode tertentu.

• Kode status HTTP: Kode status yang dikembalikan oleh API Gateway. Kode status HTTP berikut didukung:

- Kode status HTTP 2XX: Permintaan API diterima. Catatan: Permintaan yang diterima tidak menjamin keberhasilan operasi yang dimaksudkan.

- Kode status HTTP 4XX: Kesalahan pada klien, seperti kesalahan parameter.

- Kode status HTTP 5XX: Kesalahan di layanan backend. Penyedia API harus memantau erat kesalahan semacam itu.

7. Catatan penggunaan

• Anda dapat mengonfigurasi aturan peringatan berdasarkan lingkungan tempat API diterbitkan. Jika aturan peringatan yang dikonfigurasi untuk API yang diterbitkan di VPC tidak berfungsi, kami sarankan Anda melakukan langkah berikut: Masuk ke konsol API Gateway, temukan API tersebut, lalu klik nama API untuk membuka halaman detail API. Di pohon navigasi kiri, klik Pemantauan. Di halaman Data Pemantauan, periksa apakah Anda dapat menanyakan data pemantauan API berdasarkan lingkungan. Jika tidak dapat menanyakan data pemantauan berdasarkan lingkungan, kirim tiket untuk memperbarui versi instans API Gateway Anda.