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

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

ใช้การแจ้งเตือนการหมดอายุของ 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. คลิกวิเคราะห์ > กฎการแจ้งเตือน ใน UI ของ Edge
2. คลิก \+ การแจ้งเตือน
3. ป้อนข้อมูลทั่วไปต่อไปนี้เกี่ยวกับการแจ้งเตือน

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

4. กำหนดเกณฑ์และมิติข้อมูลสำหรับเงื่อนไขที่จะทริกเกอร์การแจ้งเตือน

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

5. คลิก + การแจ้งเตือน เพื่อเพิ่มการแจ้งเตือน

   รายละเอียดการแจ้งเตือน	คำอธิบาย
   ช่อง	เลือกช่องการแจ้งเตือนที่ต้องการใช้และระบุปลายทาง ได้แก่ อีเมล, 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 ตรวจพบเงื่อนไขการแจ้งเตือน ระบบจะบันทึกเงื่อนไขดังกล่าวลงในแดชบอร์ดเหตุการณ์ ใน UI ของ Edge โดยอัตโนมัติ รายการเหตุการณ์ที่แสดงในแดชบอร์ดเหตุการณ์จะรวมการแจ้งเตือนทั้งหมด ทั้งการแจ้งเตือนคงที่และการแจ้งเตือนใบรับรอง

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

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

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 ตัวอย่างต่อไปนี้จะสร้างการแจ้งเตือนการหมดอายุที่จะได้รับการทริกเกอร์เมื่อใบรับรองใดก็ตามในสภาพแวดล้อม prod จะหมดอายุในอีก 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

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

โดยค่าเริ่มต้น Get Alerts 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