إعداد تنبيهات انتهاء الصلاحية

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

استخدام تنبيه انتهاء صلاحية بروتوكول أمان طبقة النقل (TLS) لرفع إرسال إشعار عندما توشك صلاحية شهادة بروتوكول أمان طبقة النقل (TLS) في إحدى البيئات على الانتهاء.

معلومات عن شهادات بروتوكول أمان طبقة النقل (TLS)

بروتوكول أمان طبقة النقل (TLS) هو تكنولوجيا الأمان القياسية لإنشاء ارتباط مشفر بين خادم ويب وعميل ويب، مثل متصفح أو التطبيق. يضمن الرابط المشفر بقاء جميع البيانات التي يتم تمريرها بين الخادم والعميل خاصة.

شهادة بروتوكول أمان طبقة النقل (TLS) هي ملف رقمي يحدد كيانًا في معاملة باستخدام بروتوكول أمان طبقة النقل (TLS). يستخدم Edge بروتوكول أمان طبقة النقل (TLS) شهادة لتهيئة بروتوكول أمان طبقة النقل (TLS) لما يلي:

تحتوي شهادة بروتوكول أمان طبقة النقل (TLS) على تاريخ انتهاء صلاحية. في حال انتهاء صلاحية شهادة بروتوكول أمان طبقة النقل (TLS)، يفشل الاتصال ببروتوكول أمان طبقة النقل (TLS) إلى أن تقوم بتحديث الشهادة. يعني ذلك أنّ جميع الطلبات المُرسَلة إلى واجهة برمجة التطبيقات ستتعذّر إلى أن تعدّل الشهادة.

لمحة عن تنبيهات انتهاء الصلاحية

فبدلاً من انتظار انتهاء صلاحية شهادة أو لتعذُّر إرسال الطلبات إلى واجهة برمجة التطبيقات، يمكنك استخدام تنبيه انتهاء الصلاحية الذي يجب رفعه إرسال إشعار عندما توشك صلاحية أي شهادة بروتوكول أمان طبقة النقل (TLS) في إحدى البيئات على الانتهاء. بعد تشغيل التنبيه، يمكنك تعديل الشهادة حتى لا رؤية أي انقطاع في الخدمة.

عند ضبط التنبيه، لا تحدِّد شهادة فردية، بل شهادة معيَّنة. يتم تشغيل التنبيه عند جدولة أي شهادة تم نشرها لتنتهي صلاحيتها خلال النطاق الزمني المحدد.

يمكنك تعيين تنبيه انتهاء الصلاحية بحيث يحدث:

  • يوم واحد قبل انتهاء صلاحية أي شهادة
  • 14 يومًا قبل انتهاء صلاحية أي شهادة
  • 30 يومًا قبل انتهاء صلاحية أي شهادة
لمزيد من المعلومات حول التنبيهات، اطّلِع على إعداد التنبيهات والإشعارات.

إضافة تنبيهات وإشعارات انتهاء الصلاحية

لإضافة تنبيهات وإشعارات انتهاء الصلاحية:
  1. انقر على تحليل > (تحليل) > قواعد التنبيه في واجهة مستخدم Edge.
  2. انقر على +تنبيه.
  3. أدخِل المعلومات العامة التالية عن التنبيه:
    الحقل الوصف
    اسم التنبيه اسم التنبيه استخدِم اسمًا يصف العامل المفعِّل ويكون مفيدًا لك. يجب ألا يتجاوز الاسم 128 حرفًا.
    الوصف وصف التنبيه.
    نوع التنبيه اختَر انتهاء صلاحية بروتوكول أمان طبقة النقل (TLS). عرض لمحة عن أنواع التنبيهات لمعرفة المزيد
    البيئة اختَر البيئة من القائمة المنسدلة.
    الحالة انقر على زر التبديل لتفعيل التنبيه أو إيقافه.
  4. حدِّد الحدّ الأدنى والسمة للشرط الذي سيؤدي إلى ظهور التنبيه.
    حقل الشرط الوصف
    الحد الأقصى

    يمكنك ضبط النطاق الزمني للشهادات منتهية الصلاحية. يمكنك اختيار رفع تنبيه عندما تنتهي صلاحية إحدى الشهادات في:

    • يوم واحد
    • 14 يومًا
    • 30 يومًا
    السمة تم تثبيت السمات على قيمة أي شهادات TLS تتوافق مع أي شهادة بروتوكول أمان طبقة النقل (TLS) في البيئة.
  5. انقر على + إشعار لإضافة إشعار تنبيه.
    تفاصيل الإشعار الوصف
    القناة اختَر قناة الإشعارات التي تريد استخدامها وحدِّد الوجهة: البريد الإلكتروني أو Slack أو PagerDuty أو Webhook.
    الوجهة حدِّد الوجهة استنادًا إلى نوع القناة الذي اخترته:
    • البريد الإلكتروني - عنوان البريد الإلكتروني، مثل joe@company.com
    • Slack - عنوان URL لقناة Slack، مثل https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - رمز PagerDuty، مثل abcd1234efgh56789
    • الردّ التلقائي على الويب - عنوان URL للردّ التلقائي على الويب، مثل https://apigee.com/test-webhook

      ملاحظة: يمكنك تحديد وجهة واحدة فقط لكل إشعار. لتحديد وجهات متعددة لنوع القناة نفسه، أضِف إشعارات إضافية
  6. لإضافة إشعارات إضافية، كرِّر الخطوة السابقة.
  7. إذا أضفت إشعارًا، اضبط الحقول التالية:
    الحقل الوصف
    دليل إرشادي (اختياري) حقل نصي ذا تصميم مرن لتقديم وصف موجز للإجراءات المقترَحة لحلها التنبيهات عند تنشيطها. يمكنك أيضًا تحديد رابط لموقع wiki أو صفحة المنتدى الداخلية حيث بالرجوع إلى أفضل الممارسات. وسيتضمّن الإشعار المعلومات الواردة في هذا الحقل. لا يمكن أن يتجاوز المحتوى في هذا الحقل 1500 حرف.
    صمام الوقود معدل تكرار إرسال الإشعارات. اختَر قيمة من القائمة المنسدلة.
  8. انقر على حفظ.

عرض التنبيهات في لوحة بيانات "الأحداث"

عندما يكتشف Edge شرطًا للتنبيه، فإنه يسجل هذا الشرط تلقائيًا لوحة بيانات الأحداث في واجهة مستخدم Edge. قائمة الأحداث المعروضة في لوحة بيانات الأحداث تشمل جميع التنبيهات، سواء كانت ثابتة أو حاصلة على شهادة.

لعرض تنبيه:

  1. انقر على تحليل > (تحليل) > الأحداث في واجهة مستخدم Edge. تظهر لوحة بيانات الأحداث الجديدة:

  2. يمكنك فلترة لوحة بيانات "الأحداث" حسب:

    • البيئة
    • المنطقة
    • الفترة الزمنية
  3. اختَر صفًا في لوحة بيانات الحدث لعرض ملف تخزين المفاتيح الذي يحتوي على الشهادة منتهية الصلاحية إجراء مزيد من التحقيق في التنبيه. من صفحة "ملف تخزين المفاتيح"، يمكنك تحميل شهادة جديدة وحذف شهادة منتهية الصلاحية.

استخدام واجهات برمجة التطبيقات للتنبيهات مع تنبيهات انتهاء الصلاحية

معظم واجهات برمجة التطبيقات التي تستخدمها لإنشاء تنبيهات انتهاء الصلاحية وإدارتها مماثلة لتلك التي تستخدمها ذات تنبيهات ثابتة. تعمل واجهات برمجة التطبيقات للتنبيهات التالية بالطريقة نفسها لكل من التنبيهات الثابتة وتنبيهات انتهاء الصلاحية:

ومع ذلك، تحتوي بعض واجهات برمجة التطبيقات على خصائص إضافية تُستخدَم لإتاحة تنبيهات القيم الشاذة، بما في ذلك:

إنشاء تنبيه بانتهاء صلاحية أو تعديله

استخدِم واجهات برمجة التطبيقات نفسها لإنشاء أو تحديث لتنبيه انتهاء صلاحية كما تفعل حاليًا لتنبيه ثابت. نص طلب واجهة برمجة التطبيقات للإنشاء أو التحديث يكون تنبيه انتهاء الصلاحية هو نفسه المستخدَم لتنبيه ثابت، مع التغييرات التالية:

  • عليك إضافة السمات الجديدة التالية لتحديد أنّ التنبيه هو تنبيه بانتهاء صلاحية التنبيه:

    "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 لتنبيهات انتهاء الصلاحية.

ينشئ المثال التالي لطلب بيانات من واجهة برمجة التطبيقات تنبيهًا بانتهاء الصلاحية يتم تشغيله عند حدوث أي خطأ في بانتهاء صلاحية بيئة الإنتاج في غضون 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 Notifications (الحصول على التنبيهات) تلقائيًا معلومات حول جميع التنبيهات المحددة، سواء كانت ثابتة أو من تاريخ انتهاء الصلاحية. تستخدِم واجهة برمجة التطبيقات هذه الآن مَعلمات طلب البحث لتتيح لك فلترة النتائج:

  • enabled: في حال تحديد true لعرض التنبيهات المفعَّلة فقط. القيمة التلقائية هي false.
  • alertType: لتحديد نوع التنبيه المُراد عرضه. والقيم المسموح بإدراجها هي runtime، والقيم التلقائية، وcert.
  • alertSubType - لتحديد النوع الفرعي للتنبيه المراد عرضه. وتكون القيمة الافتراضية غير محددة، مما يعني إرجاع جميع الأنواع الفرعية للتنبيه. حدِّد certfixed لعرض تنبيهات انتهاء الصلاحية.

على سبيل المثال، يمكنك استخدام طلب البيانات التالي من واجهة برمجة التطبيقات لعرض التنبيهات فقط للمؤسسة المسماة 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.