ตั้งค่าการแจ้งเตือนการหมดอายุ

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

ใช้การแจ้งเตือนการหมดอายุของ TLS เพื่อส่งการแจ้งเตือนเมื่อใบรับรอง TLS ในสภาพแวดล้อมกำลังจะหมดอายุ

เกี่ยวกับใบรับรอง TLS

TLS (Transport Layer Security) เป็นเทคโนโลยีการรักษาความปลอดภัยมาตรฐานสำหรับการสร้างลิงก์ที่เข้ารหัสระหว่างเว็บเซิร์ฟเวอร์กับเว็บไคลเอ็นต์ เช่น เบราว์เซอร์หรือแอป โดยลิงก์ที่เข้ารหัสจะทำให้ข้อมูลทั้งหมดที่ส่งผ่านระหว่างเซิร์ฟเวอร์และไคลเอ็นต์ยังคงเป็นส่วนตัว

ใบรับรอง TLS เป็นไฟล์ดิจิทัลที่ระบุเอนทิตีในธุรกรรม TLS Edge ใช้ใบรับรอง TLS เพื่อกำหนดค่า TLS สำหรับสิ่งต่อไปนี้

ใบรับรอง TLS จะมีวันที่หมดอายุ หากใบรับรอง TLS หมดอายุ การเชื่อมต่อ TLS จะไม่สำเร็จจนกว่าคุณจะอัปเดตใบรับรอง ซึ่งหมายความว่าคำขอทั้งหมดที่ส่งไปยัง API จะล้มเหลวจนกว่าคุณจะอัปเดตใบรับรอง

เกี่ยวกับการแจ้งเตือนวันหมดอายุ

ใช้การแจ้งเตือนการหมดอายุเพื่อส่งการแจ้งเตือนเมื่อใบรับรอง TLS ในสภาพแวดล้อมกำลังจะหมดอายุ แทนที่จะรอให้ใบรับรองหมดอายุและเพื่อให้คำขอ API ล้มเหลว หลังจากที่แสดงการแจ้งเตือนแล้ว คุณสามารถอัปเดตใบรับรองเพื่อไม่ให้ลูกค้าเห็นการหยุดชะงักของบริการ

เมื่อกำหนดค่าการแจ้งเตือน อย่าระบุใบรับรองแต่ละรายการ แต่ระบุสภาพแวดล้อมที่เฉพาะเจาะจง ระบบจะทริกเกอร์การแจ้งเตือนเมื่อใบรับรองที่ทำให้ใช้งานได้แล้วจะหมดอายุภายในช่วงเวลาที่ระบุ

คุณตั้งค่าการแจ้งเตือนการหมดอายุให้เกิดขึ้นได้โดยทำดังนี้

  • 1 วันก่อนที่ใบรับรองจะหมดอายุ
  • 14 วันก่อนที่ใบรับรองจะหมดอายุ
  • 30 วันก่อนใบรับรองจะหมดอายุ
ดูข้อมูลเพิ่มเติมเกี่ยวกับการแจ้งเตือนได้ที่ตั้งค่าการแจ้งเตือน

เพิ่มการแจ้งเตือนวันหมดอายุ

วิธีเพิ่มการแจ้งเตือนวันหมดอายุ
  1. คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI
  2. คลิก +การแจ้งเตือน
  3. ป้อนข้อมูลทั่วไปเกี่ยวกับการแจ้งเตือนดังนี้
    ฟิลด์ คำอธิบาย
    ชื่อข้อความแจ้งเตือน ชื่อการแจ้งเตือน ใช้ชื่อที่อธิบายถึงทริกเกอร์และมีความหมายสำหรับคุณ ชื่อต้องมีอักขระไม่เกิน 128 ตัว
    คำอธิบาย คำอธิบายของการแจ้งเตือน
    ประเภทการแจ้งเตือน เลือกวันหมดอายุ TLS โปรดดูเกี่ยวกับประเภทการแจ้งเตือนสำหรับข้อมูลเพิ่มเติม
    สภาพแวดล้อม เลือกสภาพแวดล้อมจากรายการแบบเลื่อนลง
    สถานะ สลับเพื่อเปิดหรือปิดใช้การแจ้งเตือน
  4. กำหนดเกณฑ์และมิติข้อมูลสำหรับเงื่อนไขที่จะเรียกแสดงการแจ้งเตือน
    ช่องเงื่อนไข คำอธิบาย
    เกณฑ์

    กำหนดค่าช่วงเวลาสำหรับใบรับรองที่ใกล้หมดอายุ คุณเลือกส่งการแจ้งเตือนเมื่อใบรับรองกำลังจะหมดอายุได้ในพื้นที่ต่อไปนี้

    • 1 วัน
    • 14 วัน
    • 30 วัน
    มิติข้อมูล มิติข้อมูลจะคงที่เป็นค่าของใบรับรอง TLS ที่สอดคล้องกับใบรับรอง TLS ทั้งหมดในสภาพแวดล้อม
  5. คลิก + การแจ้งเตือนเพื่อเพิ่มการแจ้งเตือน
    รายละเอียดการแจ้งเตือน คำอธิบาย
    ช่อง เลือกช่องทางการแจ้งเตือนที่ต้องการใช้และระบุปลายทาง ได้แก่ Email, Slack, PagerDuty หรือเว็บฮุค
    ปลายทาง ระบุปลายทางตามประเภทแชแนลที่เลือก ดังนี้
    • อีเมล - อีเมล เช่น joe@company.com
    • Slack - URL ของช่อง Slack เช่น https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - รหัส PagerDuty เช่น abcd1234efgh56789
    • เว็บฮุค - URL ของเว็บฮุค เช่น https://apigee.com/test-webhook

      หมายเหตุ: คุณสามารถระบุปลายทางได้เพียงรายการเดียวต่อการแจ้งเตือน 1 รายการ หากต้องการระบุปลายทางหลายแห่งสำหรับช่องทางประเภทเดียวกัน ให้เพิ่มการแจ้งเตือนเพิ่มเติม
  6. หากต้องการเพิ่มการแจ้งเตือนอื่นๆ ให้ทำซ้ำขั้นตอนก่อนหน้า
  7. หากคุณเพิ่มการแจ้งเตือน ให้ตั้งค่าช่องต่อไปนี้
    ฟิลด์ คำอธิบาย
    Playbook (ไม่บังคับ) ช่องข้อความรูปแบบอิสระที่มีคำอธิบายสั้นๆ เกี่ยวกับการดำเนินการที่แนะนำเพื่อแก้ไขการแจ้งเตือนเมื่อการแจ้งเตือนเริ่มทำงาน นอกจากนี้ คุณยังระบุลิงก์ไปยัง Wiki หรือหน้าชุมชนภายในที่ใช้อ้างอิงแนวทางปฏิบัติแนะนำได้ด้วย ข้อมูลในช่องนี้จะรวมอยู่ในการแจ้งเตือน เนื้อหาในช่องนี้ต้องไม่เกิน 1,500 อักขระ
    คันเร่ง ความถี่ในการส่งการแจ้งเตือน เลือกค่าจากรายการแบบเลื่อนลง
  8. คลิกบันทึก

ดูการแจ้งเตือนในแดชบอร์ดเหตุการณ์

เมื่อ Edge ตรวจพบเงื่อนไขการแจ้งเตือน ก็จะบันทึกเงื่อนไขนั้นไปยังแดชบอร์ดเหตุการณ์ใน Edge UI โดยอัตโนมัติ รายการเหตุการณ์ที่แสดงในแดชบอร์ดเหตุการณ์ ประกอบด้วยการแจ้งเตือนทั้งหมด ทั้งแบบคงที่และใบรับรอง

วิธีดูการแจ้งเตือน

  1. คลิกวิเคราะห์ > เหตุการณ์ใน Edge UI แดชบอร์ดเหตุการณ์ใหม่จะปรากฏขึ้น

  2. กรองแดชบอร์ดเหตุการณ์ตามข้อมูลต่อไปนี้

    • สภาพแวดล้อม
    • ภูมิภาค
    • ระยะเวลา
  3. เลือกแถวในแดชบอร์ดเหตุการณ์เพื่อแสดงคีย์สโตร์ที่มีใบรับรองที่กำลังจะหมดอายุ เพื่อตรวจสอบการแจ้งเตือนเพิ่มเติม จากหน้าคีย์สโตร์ คุณอัปโหลดใบรับรองใหม่และลบใบรับรองที่กำลังจะหมดอายุได้

ใช้ API การแจ้งเตือนที่มีการแจ้งเตือนวันหมดอายุ

API ส่วนใหญ่ที่คุณใช้สร้างและจัดการการแจ้งเตือนวันหมดอายุจะเหมือนกับ API ที่คุณใช้โดยมีการแจ้งเตือนแบบคงที่ API การแจ้งเตือนต่อไปนี้ทำงานในลักษณะเดียวกันสำหรับการแจ้งเตือนคงที่และวันหมดอายุ

อย่างไรก็ตาม API บางรายการมีคุณสมบัติเพิ่มเติมที่ใช้รองรับการแจ้งเตือนความผิดปกติ ได้แก่

สร้างหรืออัปเดตการแจ้งเตือนวันหมดอายุ

ใช้ API เดียวกันเพื่อสร้างหรืออัปเดตการแจ้งเตือนการหมดอายุเหมือนกับที่คุณทำอยู่ในปัจจุบันกับการแจ้งเตือนแบบคงที่ เนื้อหาของการเรียก API เพื่อสร้างหรืออัปเดตการแจ้งเตือนวันหมดอายุจะเหมือนกับที่ใช้ในการแจ้งเตือนแบบคงที่ โดยมีการเปลี่ยนแปลงดังต่อไปนี้

  • คุณต้องเพิ่มพร็อพเพอร์ตี้ใหม่ต่อไปนี้เพื่อระบุว่าการแจ้งเตือนเป็นการแจ้งเตือนการหมดอายุ

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

    ค่าเริ่มต้นของพร็อพเพอร์ตี้เหล่านี้คือ

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

  • ในอาร์เรย์ conditions

    • พร็อพเพอร์ตี้ metrics จะใช้เฉพาะค่าของ expiration
    • ใช้พร็อพเพอร์ตี้ gracePeriodSeconds เพื่อระบุช่วงเวลาการหมดอายุของใบรับรองเป็นวินาที ไปจนถึงระยะเวลาสูงสุด 30 วัน
    • ระบบไม่รองรับพร็อพเพอร์ตี้ threshold, durationSeconds และ comparator
  • ในองค์ประกอบ dimensions ของอาร์เรย์ conditions
    • คุณต้องตั้งค่าของพร็อพเพอร์ตี้ certificate เป็น ANY
    • คุณต้องตั้งค่าของพร็อพเพอร์ตี้ proxy เป็น ALL
    • ระบบไม่รองรับพร็อพเพอร์ตี้ statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName
  • ไม่รองรับพร็อพเพอร์ตี้ reportEnabled สำหรับการแจ้งเตือนวันหมดอายุ

ตัวอย่างการเรียก API ต่อไปนี้จะสร้างการแจ้งเตือนวันหมดอายุที่จะทริกเกอร์เมื่อ Cery ในสภาพแวดล้อมการผลิตจะหมดอายุภายใน 30 วันนับจากนี้ ระบบจะส่งการแจ้งเตือนไปยังอีเมลที่ระบุไว้ เมื่อมีการทริกเกอร์การแจ้งเตือน

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
}'

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในรับโทเค็นเพื่อการเข้าถึง OAuth 2.0 ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างนี้ได้ที่ใช้ cURL

รับการแจ้งเตือนวันหมดอายุ

โดยค่าเริ่มต้น API รับการแจ้งเตือนจะแสดงข้อมูลเกี่ยวกับการแจ้งเตือนทั้งหมดที่กำหนดไว้ ทั้งที่คงที่และหมดอายุ ตอนนี้ API นี้ใช้พารามิเตอร์การค้นหาเพื่อให้คุณกรองผลลัพธ์ ดังนี้

  • enabled - หาก true ระบุว่าให้แสดงเฉพาะการแจ้งเตือนที่เปิดใช้เท่านั้น ค่าเริ่มต้นคือ false
  • alertType - ระบุประเภทการแจ้งเตือนที่จะแสดงผล ค่าที่อนุญาตคือ runtime, ค่าเริ่มต้น และ cert
  • alertSubType - ระบุประเภทการแจ้งเตือนที่จะแสดงผล ค่าเริ่มต้นคือไม่ได้ตั้งค่า ซึ่งหมายความว่าจะแสดงประเภทย่อยของการแจ้งเตือนทั้งหมด ระบุ certfixed เพื่อแสดงการแจ้งเตือนวันหมดอายุ

ตัวอย่างเช่น ใช้การเรียก API ต่อไปนี้เพื่อส่งคืนเฉพาะการแจ้งเตือนสำหรับองค์กรชื่อ myorg เท่านั้น:

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

การโทรต่อไปนี้จะแสดงเฉพาะการแจ้งเตือนวันหมดอายุ ทั้งที่เปิดและปิดใช้อยู่

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

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในรับโทเค็นเพื่อการเข้าถึง OAuth 2.0 ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างนี้ได้ที่ใช้ cURL