Menyiapkan pemberitahuan habis masa berlaku

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Gunakan pemberitahuan masa berlaku TLS untuk mengajukan notifikasi saat sertifikat TLS di suatu lingkungan akan kedaluwarsa.

Tentang sertifikat TLS

TLS (Transport Layer Security) adalah teknologi keamanan standar untuk membuat tautan terenkripsi antara server web dan klien web, seperti {i>browser<i} atau . Tautan terenkripsi memastikan bahwa semua data yang melewati server dan klien tetap pribadi.

Sertifikat TLS adalah file digital yang mengidentifikasi entitas dalam transaksi TLS. Edge menggunakan TLS untuk mengonfigurasi TLS bagi:

  • Akses ke proxy API Anda oleh klien API. Menggunakan host virtual untuk mengonfigurasi TLS.
  • Akses ke layanan backend Anda oleh Edge. Menggunakan endpoint target dan server target di Edge Message Processor untuk mengonfigurasi TLS.

Sertifikat TLS berisi tanggal habis masa berlaku. Jika masa berlaku sertifikat TLS habis, koneksi TLS akan gagal hingga Anda memperbarui sertifikat. Artinya, semua permintaan ke API Anda akan gagal hingga Anda memperbarui sertifikat.

Tentang notifikasi masa berlaku habis

Daripada menunggu masa berlaku sertifikat berakhir, dan agar permintaan ke API Anda gagal, gunakan pemberitahuan masa berlaku untuk diajukan notifikasi ketika sertifikat TLS di suatu lingkungan akan kedaluwarsa. Setelah pemberitahuan dipicu, Anda dapat memperbarui sertifikat agar pelanggan tidak mengalami gangguan layanan.

Saat mengonfigurasi pemberitahuan, jangan tentukan sertifikat satu per satu, melainkan lingkungan tertentu. Pemberitahuan akan dipicu saat sertifikat yang di-deploy dijadwalkan berakhir dalam rentang waktu yang ditentukan.

Anda dapat menyetel agar pemberitahuan masa berlaku habis:

  • 1 hari sebelum masa berlaku sertifikat habis
  • 14 hari sebelum masa berlaku sertifikat habis
  • 30 hari sebelum masa berlaku sertifikat habis
Untuk mengetahui informasi selengkapnya tentang pemberitahuan, lihat Menyiapkan pemberitahuan dan notifikasi.

Menambahkan pemberitahuan dan pemberitahuan masa berlaku habis

Untuk menambahkan pemberitahuan dan pemberitahuan masa berlaku habis:
  1. Klik Analisis > Aturan Pemberitahuan di UI Edge.
  2. Klik +Alert.
  3. Masukkan informasi umum berikut tentang pemberitahuan:
    Kolom Deskripsi
    Nama notifikasi Nama notifikasi. Gunakan nama yang menjelaskan pemicu dan berarti bagi Anda. Nama tidak boleh lebih dari 128 karakter.
    Deskripsi Deskripsi notifikasi.
    Jenis Notifikasi Pilih TLS Berakhir. Lihat Tentang jenis notifikasi untuk mengetahui informasi lebih lanjut.
    Lingkungan Pilih lingkungan dari menu drop-down.
    Status Klik tombol untuk mengaktifkan atau menonaktifkan notifikasi.
  4. Tentukan batas dan dimensi untuk kondisi yang akan memicu pemberitahuan.
    Kolom Kondisi Deskripsi
    Batas

    Konfigurasi rentang waktu untuk sertifikat yang akan habis masa berlakunya. Anda dapat memilih untuk menaikkan pemberitahuan saat masa berlaku sertifikat akan berakhir dalam:

    • 1 hari
    • 14 hari
    • 30 hari
    Dimensi Dimensi ini tetap ke nilai Setiap Sertifikat TLS yang sesuai dengan setiap sertifikat TLS di lingkungan.
  5. Klik + Notifikasi untuk menambahkan notifikasi peringatan.
    Detail Notifikasi Deskripsi
    Saluran Pilih saluran notifikasi yang ingin digunakan dan tentukan tujuannya: Email, Slack, PagerDuty, atau Webhook.
    Destination Tentukan tujuan berdasarkan jenis saluran yang dipilih:
    • Email - Alamat email, seperti joe@company.com
    • Slack - URL channel Slack, seperti https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - Kode PagerDuty, seperti abcd1234efgh56789
    • Webhook - URL Webhook, seperti https://apigee.com/test-webhook

      Catatan: Anda hanya dapat menetapkan satu tujuan per notifikasi. Untuk menentukan beberapa tujuan untuk jenis channel yang sama, tambahkan notifikasi tambahan.
  6. Untuk menambahkan notifikasi tambahan, ulangi langkah sebelumnya.
  7. Jika Anda menambahkan notifikasi, tetapkan kolom berikut:
    Kolom Deskripsi
    Playbook (Opsional) Kolom teks bentuk bebas untuk memberikan deskripsi singkat tentang tindakan yang disarankan untuk me-resolve pemberitahuan saat ditembakkan. Anda juga dapat menentukan tautan ke laman wiki atau komunitas internal Anda Anda mereferensikan praktik terbaik. Informasi di kolom ini akan disertakan dalam notifikasi. Konten di kolom ini tidak boleh melebihi 1.500 karakter.
    Gas Frekuensi pengiriman notifikasi. Pilih nilai dari menu drop-down.
  8. Klik Simpan.

Melihat pemberitahuan di dasbor Peristiwa

Saat mendeteksi kondisi pemberitahuan, Edge akan otomatis mencatat kondisi tersebut ke Dasbor Events di UI Edge. Daftar peristiwa yang ditampilkan di dasbor Peristiwa mencakup semua pemberitahuan, baik pemberitahuan tetap maupun sertifikat.

Untuk melihat notifikasi:

  1. Klik Analisis > Peristiwa di UI Edge. Dasbor Peristiwa baru akan muncul:

  2. Filter dasbor Peristiwa menurut:

    • Lingkungan
    • Wilayah
    • Jangka waktu
  3. Pilih baris di dasbor Peristiwa untuk menampilkan Keystore yang berisi sertifikat yang akan habis masa berlakunya menyelidiki pemberitahuan lebih lanjut. Dari halaman Keystore, Anda dapat mengupload sertifikat baru dan menghapus sertifikat yang akan kedaluwarsa.

Menggunakan API pemberitahuan dengan pemberitahuan habis masa berlaku

Sebagian besar API yang Anda gunakan untuk membuat dan mengelola pemberitahuan habis masa berlaku sama dengan yang Anda gunakan dengan pemberitahuan tetap. API pemberitahuan berikut berfungsi dengan cara yang sama untuk pemberitahuan tetap dan pemberitahuan masa berlaku:

Namun, beberapa API memiliki properti tambahan yang digunakan untuk mendukung notifikasi anomali, termasuk:

Membuat atau memperbarui pemberitahuan masa berlaku habis

Gunakan API yang sama untuk membuat atau perbarui peringatan masa berlaku habis seperti yang Anda lakukan untuk peringatan tetap. Isi panggilan API yang akan dibuat atau diupdate pemberitahuan masa berlaku sama seperti yang digunakan untuk pemberitahuan tetap, dengan perubahan berikut:

  • Anda harus menambahkan properti baru berikut untuk menentukan bahwa pemberitahuan adalah peringatan masa berlaku habis:

    "alertType": "cert"
"alertSubType": "certfixed"

    Nilai default untuk properti ini adalah:

    "alertType": "runtime"
"alertSubType": "fixed"

  • Dalam array conditions:

    • Properti metrics hanya menggunakan nilai expiration.
    • Gunakan properti gracePeriodSeconds untuk menentukan rentang waktu habis masa berlaku sertifikat dalam hitungan detik, hingga durasi maksimum 30 hari.
    • Properti threshold, durationSeconds, dan comparator tidak didukung.
  • Dalam elemen dimensions array conditions:
    • Anda harus menetapkan nilai properti certificate ke ANY.
    • Anda harus menetapkan nilai properti proxy ke ALL.
    • statusCode, developerApp, collection, faultCodeCategory, Properti faultCodeSubCategory dan faultCodeName tidak didukung.
  • Properti reportEnabled tidak didukung untuk notifikasi masa berlaku habis.

Contoh panggilan API berikut membuat peringatan masa berlaku yang dipicu saat ada sertifikat prod akan kedaluwarsa dalam 30 hari ke depan. Notifikasi dikirim ke alamat email yang ditentukan saat pemberitahuan dipicu:

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan di Dapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Dapatkan notifikasi masa berlaku habis

Secara default, Get Alerts API menampilkan informasi tentang semua notifikasi yang ditetapkan, baik notifikasi tetap maupun notifikasi berakhir. API ini sekarang menggunakan parameter kueri agar Anda dapat memfilter hasil:

  • enabled - Jika true menentukan untuk hanya menampilkan pemberitahuan yang diaktifkan. Nilai defaultnya adalah false.
  • alertType - Menentukan jenis notifikasi yang akan ditampilkan. Nilai yang diizinkan adalah runtime, default, dan cert.
  • alertSubType - Menentukan subjenis notifikasi yang akan ditampilkan. Nilai defaultnya adalah tidak ditetapkan, yang berarti tampilkan semua subjenis pemberitahuan. Tentukan certfixed untuk menampilkan notifikasi masa berlaku.

Misalnya, gunakan panggilan API berikut untuk hanya menampilkan notifikasi untuk organisasi bernama myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

Panggilan berikut hanya menampilkan notifikasi masa berlaku habis, baik yang diaktifkan maupun dinonaktifkan:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan di Dapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.