API Gateway:Konfigurasi Peringatan untuk API

1. Asosiasikan sumber daya

Fitur pemantauan dan peringatan API Gateway mendukung berbagai kebutuhan bisnis melalui metrik pemantauan berikut:

• HttpStatusCode

• Waktu respons API

• Total permintaan API

• inbound traffic

• outbound traffic

Anda dapat membuat aturan peringatan dan mengaitkannya dengan satu atau beberapa API menggunakan salah satu metode berikut:

• Secara manual mengasosiasikan satu atau beberapa API. Metode ini cocok untuk menerapkan aturan peringatan yang sama pada API tertentu. Aturan peringatan tidak terpengaruh oleh perubahan konfigurasi API.

• Mengasosiasikan kelompok API. Aturan peringatan diterapkan ke semua API dalam kelompok tersebut untuk memantau status pemanggilannya. Penambahan, penghapusan, atau perubahan API dalam kelompok akan secara otomatis menyinkronkan aturan peringatan.

• Mengasosiasikan semua resource. Aturan diterapkan ke seluruh API di API Gateway di bawah akun Anda. Metode ini cocok jika Anda mengelola jumlah API yang terbatas.

2. Konfigurasi tingkat dan metode peringatan

CloudMonitor dapat memicu peringatan Critical, Warning, atau Info berdasarkan rentang ambang batas. Setiap tingkat dapat mengirim notifikasi melalui saluran berbeda. Untuk detail tentang pemberitahuan peringatan, lihat Ikhtisar.

• Critical: Panggilan telepon + SMS message + email + chatbot DingTalk (fitur berbayar).

• Warning: SMS message + email + chatbot DingTalk.

• Info: Email + chatbot DingTalk.

3. Asosiasikan aturan peringatan dengan satu atau beberapa API

Untuk detail tentang konfigurasi templat peringatan, aturan peringatan, kontak notifikasi, dan pemberitahuan peringatan, lihat Ikhtisar.

1. Masuk ke Konsol API Gateway dan pilih Wilayah. Di panel navigasi kiri, pilih API Management > API List, lalu temukan API yang ingin Anda tambahkan aturan peringatannya.

2. Di API List, klik nama API untuk membuka halaman detailnya. Di panel navigasi kiri, klik Monitoring. Kemudian, klik Alert di pojok kanan atas untuk membuka Konsol CloudMonitor.

3. Di halaman Alert Rules, klik Create Alert Rule. Di halaman Create Alert Rule, atur Product menjadi API Gateway dan Resource Range menjadi Instance. Klik Add Instance di bawahnya. Di kotak dialog Add Instance, pilih API yang ingin Anda tambahkan.

4. Asosiasikan aturan peringatan dengan kelompok API

1. Untuk menerapkan aturan peringatan yang sama ke semua API dalam kelompok API, buka halaman detail kelompok tersebut dan klik Enable CloudMonitor di pojok kanan atas.

2. Saat mengonfigurasi CloudMonitor untuk kelompok API pertama kali, sebuah kotak dialog akan meminta Anda membuat peran terkait layanan AliyunServiceRoleForApiGatewayMonitoring.

3. Setelah Anda mengklik OK, muncul pesan yang menunjukkan bahwa CloudMonitor telah diaktifkan dan menyertakan nama kelompok aplikasi terkait di CloudMonitor. Dengan otorisasi Anda, API Gateway membuat kelompok aplikasi ini untuk mencerminkan kelompok API saat ini. Namanya mengikuti format APIGATEWAY_${region}_${groupId}, di mana region adalah wilayah kelompok API dan groupId adalah ID-nya.

4. Setelah CloudMonitor diaktifkan, klik Go to CloudMonitor to Configure di halaman detail kelompok untuk langsung mengonfigurasi aturan peringatan bagi kelompok aplikasi tersebut.

5. Asosiasikan aturan peringatan dengan semua API

Prosedurnya sama seperti pada Buat aturan peringatan untuk satu atau beberapa API, kecuali Anda harus mengatur Resource Range menjadi "All Resources". Setelah diatur, aturan peringatan yang sama berlaku untuk semua API di seluruh wilayah di API Gateway di bawah akun Anda. Dengan metode ini, Anda tidak dapat memilih API tertentu.

6. Aturan peringatan yang didukung oleh API Gateway

Anda dapat mengonfigurasi peringatan berdasarkan lima metrik yang disediakan oleh API Gateway: HttpStatusCode, waktu respons API, total permintaan API, inbound traffic, dan outbound traffic.

• Waktu respons API: waktu respons dari layanan backend.

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

• Inbound traffic: trafik permintaan yang diterima oleh API Gateway dari klien dalam periode tertentu.

• Outbound traffic: trafik permintaan yang dikirim oleh API Gateway ke layanan backend 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 menandakan bahwa operasi yang dimaksudkan oleh permintaan tersebut berhasil.

-Kode status HTTP 4XX: Terjadi kesalahan di sisi klien, seperti kesalahan parameter.

-Kode 5XX: Menunjukkan kesalahan di sisi server. Pengembang API biasanya harus memantau kesalahan ini secara ketat.

7. Catatan penggunaan

• Anda dapat mengonfigurasi aturan peringatan berdasarkan lingkungan tempat API Anda dipublikasikan. Jika aturan peringatan yang dikonfigurasi untuk API yang dipublikasikan di VPC tidak berlaku, kami menyarankan langkah-langkah berikut: Masuk ke Konsol API Gateway, temukan API tersebut, lalu klik nama API untuk membuka halaman detailnya. Di pohon navigasi kiri, klik Monitoring. Di halaman Monitoring Data, periksa apakah Anda dapat mengkueri data pemantauan API berdasarkan lingkungan. Jika Anda tidak dapat mengkueri data pemantauan berdasarkan lingkungan, ajukan Tiket untuk memperbarui versi instans API Gateway Anda.