Menyiapkan pemberitahuan habis masa berlaku

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

Gunakan pemberitahuan masa berlaku TLS untuk menyampaikan notifikasi saat sertifikat TLS di lingkungan akan berakhir masa berlakunya.

Tentang sertifikat TLS

TLS (Transport Layer Security) adalah teknologi keamanan standar untuk membuat link yang dienkripsi antara server web dan klien web, seperti browser atau aplikasi. Link terenkripsi memastikan bahwa semua data yang diteruskan antara server dan klien tetap bersifat pribadi.

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

  • Akses ke proxy API Anda melalui klien API. Gunakan host virtual untuk mengonfigurasi TLS.
  • Akses ke layanan backend Anda dengan Edge. Gunakan endpoint target dan server target pada Prosesor Pesan Edge untuk mengonfigurasi TLS.

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

Tentang notifikasi masa berlaku

Daripada menunggu hingga masa berlaku sertifikat berakhir dan agar permintaan ke API Anda gagal, gunakan pemberitahuan masa berlaku habis untuk memunculkan notifikasi saat masa berlaku sertifikat TLS di lingkungan akan segera berakhir. Setelah pemberitahuan dipicu, Anda dapat memperbarui sertifikat agar pelanggan tidak mengalami gangguan layanan.

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

Anda dapat menyetel agar notifikasi habis masa berlaku:

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

Menambahkan notifikasi dan pemberitahuan berakhirnya masa berlaku

Untuk menambahkan pemberitahuan dan notifikasi habis masa berlaku:
  1. Klik Analyze > Alert Rules di UI Edge.
  2. Klik +Alert.
  3. Masukkan informasi umum berikut tentang notifikasi:
    Kolom Deskripsi
    Nama Pemberitahuan Nama notifikasi. Gunakan nama yang mendeskripsikan pemicu dan yang berarti bagi Anda. Nama tidak boleh lebih dari 128 karakter.
    Deskripsi Deskripsi notifikasi.
    Jenis Notifikasi Pilih Masa Berlaku TLS. Lihat Tentang jenis notifikasi untuk informasi selengkapnya.
    Environment Pilih lingkungan dari menu drop-down.
    Status Tekan tombol untuk mengaktifkan atau menonaktifkan notifikasi.
  4. Tentukan nilai minimum dan dimensi untuk kondisi yang akan memicu pemberitahuan.
    Kolom Kondisi Deskripsi
    Nilai minimum

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

    • 1 hari
    • 14 hari
    • 30 hari
    Dimensi Dimensi ini ditetapkan ke nilai Semua Sertifikat TLS yang sesuai dengan semua sertifikat TLS di lingkungan.
  5. Klik + Notifikasi untuk menambahkan notifikasi.
    Detail Notifikasi Deskripsi
    Channel Pilih saluran notifikasi yang ingin Anda gunakan 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 menentukan satu tujuan per notifikasi. Guna menentukan beberapa tujuan untuk jenis saluran yang sama, tambahkan notifikasi tambahan.
  6. Untuk menambahkan notifikasi lainnya, 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 guna menyelesaikan notifikasi saat diaktifkan. Anda juga dapat menentukan link ke wiki internal atau halaman komunitas tempat merujuk pada praktik terbaik. Informasi di kolom ini akan disertakan dalam notifikasi. Konten di kolom ini tidak boleh lebih dari 1500 karakter.
    Gas Frekuensi yang digunakan untuk mengirimkan notifikasi. Pilih nilai dari menu drop-down.
  8. Klik Simpan.

Melihat notifikasi di dasbor Peristiwa

Saat Edge 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 tetap maupun sertifikat.

Untuk melihat sebuah pemberitahuan:

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

  2. Filter dasbor Peristiwa menurut:

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

Menggunakan API pemberitahuan dengan pemberitahuan masa berlaku

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

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

Membuat atau memperbarui pemberitahuan tanggal habis masa berlaku

Gunakan API yang sama untuk membuat atau memperbarui pemberitahuan masa berlaku seperti yang Anda lakukan saat ini untuk pemberitahuan tetap. Isi panggilan API untuk membuat atau memperbarui pemberitahuan masa berlaku habis sama dengan yang digunakan untuk pemberitahuan tetap, dengan perubahan berikut:

  • Anda harus menambahkan properti baru berikut untuk menentukan bahwa notifikasi tersebut adalah notifikasi habis masa berlaku:

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

    Nilai default 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 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.
    • Properti statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName tidak didukung.
  • Properti reportEnabled tidak didukung untuk notifikasi masa berlaku.

Contoh panggilan API berikut membuat pemberitahuan masa berakhir yang dipicu saat masa berlaku apa pun di lingkungan produksi akan berakhir 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, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Dapatkan notifikasi masa berlaku

Secara default, Get Alerts API menampilkan informasi tentang semua pemberitahuan yang ditentukan, baik peringatan tetap maupun yang sudah berakhir. API ini sekarang menggunakan parameter kueri sehingga Anda dapat memfilter hasil:

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

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

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

Panggilan berikut hanya menampilkan pemberitahuan masa berlaku, baik 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, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.