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

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

استخدِم تنبيهًا بشأن انتهاء صلاحية بروتوكول أمان طبقة النقل (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 يومًا
   السمة	يتم تثبيت السمة على القيمة أي شهادات TLS بما يتوافق مع أي شهادة TLS في البيئة.

5. انقر على + إشعار لإضافة إشعار تنبيه.

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

6. لإضافة إشعارات أخرى، كرِّر الخطوة السابقة.
7. إذا أضفت إشعارًا، اضبط الحقول التالية:

   الحقل	الوصف
   دليل إرشادي	(اختياري) حقل نصي حرّ لتقديم وصف موجز للإجراءات المقترَحة لحلّ التنبيهات عند تفعيلها. يمكنك أيضًا تحديد رابط يؤدي إلى صفحة الويكي الداخلية أو صفحة المنتدى التي تشير فيها إلى أفضل الممارسات. سيتم تضمين المعلومات الواردة في هذا الحقل في الإشعار. يجب ألا يتجاوز عدد الأحرف في هذا الحقل 1,500 حرف.
   صمام الوقود	معدّل تكرار إرسال الإشعارات اختَر قيمة من القائمة المنسدلة.

8. انقر على حفظ.

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

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

لعرض تنبيه:

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

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

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

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

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

• الحصول على تنبيه: للحصول على تعريف تنبيه ثابت أو تنبيه بشأن قيمة شاذة
• الحصول على سجلّ التنبيه: للحصول على مقاييس سجلّ التنبيه
• حذف تنبيه: لحذف تعريف تنبيه ثابت أو تنبيه بشأن قيمة غير طبيعية
• الحصول على مثيل تنبيه: للحصول على معلومات حول تنبيه تم تشغيله.
• الحصول على عدد التنبيهات: للحصول على إجمالي عدد التنبيهات

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

• تلقّي تنبيهات: تعرض هذه القائمة جميع التنبيهات، بما في ذلك التنبيهات التي تم إصلاحها وتنبيهات الحالات الشاذة.
• إنشاء تنبيه: يمكنك إنشاء تنبيه ثابت أو تنبيه بشأن القيم الشاذة.
• تعديل تنبيه: لتعديل تعريف تنبيه ثابت أو تنبيه عن خلل

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

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

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

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

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

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 معلومات حول جميع التنبيهات المحدّدة، سواء كانت ثابتة أو تنتهي صلاحيتها. تتلقّى واجهة برمجة التطبيقات هذه الآن مَعلمات طلب البحث لتتيح لك فلترة النتائج:

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