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

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

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

لمحة عن شهادات TLS

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

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

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

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

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

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

عند تهيئة التنبيه، لا تحدد شهادة فردية، ولكن تحدد بيئة محددة. يتم تشغيل التنبيه عندما تتم جدولة انتهاء صلاحية أي شهادة تم نشرها خلال النطاق الزمني المحدد.

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

• قبل يوم واحد من انتهاء صلاحية أي شهادة
• قبل 14 يومًا من انتهاء صلاحية أي شهادة
• قبل 30 يومًا من انتهاء صلاحية أي شهادة

لمزيد من المعلومات عن التنبيهات، يُرجى الاطّلاع على إعداد التنبيهات والإشعارات.

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

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

1. انقر على تحليل > قواعد التنبيه في واجهة مستخدم Edge.
2. انقر على +تنبيه.
3. أدخِل المعلومات العامة التالية عن التنبيه:

   الحقل	الوصف
   اسم التنبيه	اسم التنبيه. استخدِم اسمًا يصف المشغِّل ويكون مفيدًا لك. يجب ألا يتجاوز الاسم 128 حرفًا.
   الوصف	وصف التنبيه.
   نوع التنبيه	اختَر انتهاء صلاحية بروتوكول أمان طبقة النقل (TLS). راجِع لمحة عن أنواع التنبيهات للحصول على مزيد من المعلومات.
   البيئة	اختَر البيئة من القائمة المنسدلة.
   الحالة	مفتاح التبديل لتفعيل التنبيه أو إيقافه.

4. حدِّد الحد الأدنى والسمة للشرط الذي سيؤدي إلى ظهور التنبيه.

   حقل الشرط	الوصف
   الحد الأقصى	يمكنك ضبط النطاق الزمني للشهادات منتهية الصلاحية. يمكنك اختيار رفع تنبيه عندما ستنتهي صلاحية الشهادة في: يوم واحد 14 يومًا 30 يومًا
   السمة	يتم تثبيت السمات على قيمة أي شهادات لطبقة النقل الآمنة تتوافق مع أي شهادة لطبقة النقل الآمنة في البيئة.

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 ملاحظة: يمكنك تحديد وجهة واحدة فقط لكل إشعار. لتحديد وجهات متعددة لنوع القناة نفسه، أضِف إشعارات أخرى.

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

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

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.

تلقّي تنبيهات بشأن انتهاء الصلاحية

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

• 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.