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

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

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

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

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

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

• สิทธิ์เข้าถึงพร็อกซี API ตามไคลเอ็นต์ API ใช้โฮสต์เสมือน เพื่อกำหนดค่า TLS
• สิทธิ์เข้าถึงบริการแบ็กเอนด์โดย Edge ใช้ปลายทางเป้าหมายและเซิร์ฟเวอร์เป้าหมาย ในโปรแกรม Edge Message Processor เพื่อกำหนดค่า TLS

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

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

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

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

คุณกำหนดให้ระบบแจ้งเตือนวันหมดอายุได้ดังนี้

• 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 เดียวกันเพื่อสร้าง หรือ update การแจ้งเตือนวันหมดอายุเหมือนที่ทำกับการแจ้งเตือนแบบคงที่ เนื้อหาของการเรียก 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