راه‌اندازی هشدارهای انقضا

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

از هشدار انقضای «امنیت لایه انتقال» برای ایجاد اعلان وقتی گواهینامه «امنیت لایه انتقال» در محیطی رو به انقضا است استفاده کنید.

درباره گواهینامه‌های «امنیت لایه انتقال»

«امنیت لایه انتقال» (TLS) فناوری امنیتی استاندارد برای ایجاد پیوند رمزگذاری‌شده بین سرور وب و کارخواه وب، مثل مرورگر یا برنامه، است. پیوند رمزگذاری‌شده تضمین می‌کند که همه داده‌های ردوبدل‌شده بین سرور و کارخواه خصوصی باقی بماند.

گواهینامه «امنیت لایه انتقال» فایلی دیجیتال است که نهادی را در تراکنش «امنیت لایه انتقال» شناسایی می‌کند. ‫Edge از گواهینامه TLS برای پیکربندی TLS برای موارد زیر استفاده می‌کند:

• دسترسی کارخواهان API به پراکسی‌های API شما. برای پیکربندی «امنیت لایه انتقال»، از میزبان‌های مجازی استفاده کنید.
• دسترسی Edge به سرویس‌های زیرین شما. برای پیکربندی «امنیت لایه انتقال»، از نقطه‌های پایانی هدف و سرورهای هدف در «پردازشگر پیام لبه» استفاده کنید.

گواهینامه TLS حاوی تاریخ انقضا است. اگر گواهینامه «امنیت لایه انتقال» منقضی شود، اتصال «امنیت لایه انتقال» تا زمانی که گواهینامه را به‌روزرسانی نکنید برقرار نمی‌شود. این یعنی تا زمانی که گواهینامه را به‌روزرسانی نکنید، همه درخواست‌های API شما ناموفق خواهد بود.

درباره هشدارهای انقضا

به‌جای اینکه منتظر بمانید گواهینامه‌ای منقضی شود و درخواست‌های شما به «میانای برنامه‌سازی کاربردی» ناموفق شود، از هشدار انقضا برای ایجاد اعلان وقتی هر گواهینامه «امنیت لایه انتقال» در محیطی درحال انقضا است استفاده کنید. پس‌از راه‌اندازی هشدار، می‌توانید گواهینامه را به‌روز کنید تا مشتریانتان هیچ وقفه‌ای در سرویس نبینند.

هنگام پیکربندی هشدار، گواهینامه فردی را مشخص نکنید، بلکه محیط خاصی را مشخص کنید. وقتی هر گواهینامه مستقرشده‌ای زمان انقضایش در محدوده زمانی مشخص‌شده باشد، هشدار راه‌اندازی می‌شود.

می‌توانید هشدار انقضا را روی یکی از این گزینه‌ها تنظیم کنید:

• ‫۱ روز قبل‌از انقضای هر گواهینامه
• ‫۱۴ روز قبل‌از انقضای هر گواهینامه
• ‫۳۰ روز قبل‌از انقضای هر گواهینامه

افزودن اعلان‌ها و هشدارهای انقضا

1. در «میانای کاربری Edge»، روی تجزیه‌وتحلیل > قوانین هشدار کلیک کنید.
2. روی +هشدار کلیک کنید.
3. اطلاعات عمومی زیر را درباره هشدار وارد کنید:

   فیلد	شرح
   نام هشدار	نام هشدار. از نامی استفاده کنید که محرک را توصیف کند و برای شما معنادار باشد. نام نباید بیش‌از ۱۲۸ نویسه داشته باشد.
   شرح	شرح هشدار.
   نوع هشدار	انقضای TLS را انتخاب کنید. برای اطلاعات بیشتر، درباره انواع هشدارها را ببینید.
   محیط زیست	محیط را از فهرست کرکره‌ای انتخاب کنید.
   وضعیت	برای فعال یا غیرفعال کردن هشدار، کلید را جابه‌جا کنید.

4. آستانه و ابعاد را برای شرایطی که باعث راه‌اندازی هشدار می‌شود تعریف کنید.

   فیلد وضعیت	شرح
   آستانه	محدوده زمانی گواهینامه‌های منقضی را پیکربندی کنید. می‌توانید انتخاب کنید که وقتی گواهینامه‌ای در این مدت منقضی می‌شود هشدار دریافت کنید: ‫۱ روز ۱۴ روز ۳۰ روز
   ابعاد	ابعاد روی مقدار هر گواهینامه TLS ثابت شده است که با هر گواهینامه TLS در محیط مطابقت دارد.

5. برای افزودن اعلان هشدار، روی + اعلان کلیک کنید.

   جزئیات اعلان	شرح
   کانال	کانال اعلانی را که می‌خواهید استفاده کنید انتخاب کنید و مقصد را مشخص کنید: ایمیل، Slack،‏ PagerDuty، یا Webhook.
   مقصد	مقصد را براساس نوع کانال انتخاب‌شده مشخص کنید: ایمیل - نشانی ایمیل، مثل joe@company.com ‫Slack - نشانی وب کانال Slack، برای نمونه https://hooks.slack.com/services/T00000000/B00000000/XXXXX PagerDuty - کد PagerDuty، مثل abcd1234efgh56789 وب‌قلاب - نشانی وب وب‌قلاب، مثل https://apigee.com/test-webhook توجه: برای هر اعلان فقط می‌توانید یک مقصد مشخص کنید. برای مشخص کردن چندین مقصد برای یک نوع کانال، اعلان‌های بیشتری اضافه کنید.

6. برای افزودن اعلان‌های بیشتر، مرحله قبلی را تکرار کنید.
7. اگر اعلانی اضافه کردید، فیلدهای زیر را تنظیم کنید:

   فیلد	شرح
   Playbook	(اختیاری) فیلد نوشتار آزاد برای ارائه شرح کوتاهی از کنش‌های توصیه‌شده برای رفع هشدارها هنگام فعال شدن. همچنین می‌توانید پیوندی به ویکی داخلی یا صفحه انجمن خود که در آن به بهترین روش‌ها اشاره می‌کنید، مشخص کنید. اطلاعات این فیلد در اعلان اضافه خواهد شد. محتوای این فیلد نباید از ۱۵۰۰ نویسه بیشتر باشد.
   تنظیم کردن سرعت	فراوانی ارسال اعلان‌ها. مقداری را از فهرست کرکره‌ای انتخاب کنید.

8. روی ذخیره کلیک کنید.

مشاهده هشدارها در داشبورد «رویدادها»

وقتی Edge وضعیت هشداری را تشخیص می‌دهد، آن وضعیت را به‌طور خودکار در داشبورد رویدادها در رابط کاربری Edge ثبت می‌کند. فهرست رویدادهای نمایش‌داده‌شده در داشبورد «رویدادها» شامل همه هشدارهای ثابت و گواهینامه است.

برای مشاهده هشدار:

1. در «واسط کاربر Edge»، روی تجزیه‌وتحلیل > رویدادها کلیک کنید. داشبورد جدید «رویدادها» ظاهر می‌شود:

2. فیلتر کردن داشبورد «رویدادها» براساس:

   • محیط زیست
   • منطقه
   • دوره زمانی
3. ردیفی را در «داشبورد رویداد» انتخاب کنید تا «انبار کلید» حاوی گواهینامه منقضی را نشان دهد تا هشدار را بیشتر بررسی کنید. از صفحه «انبار کلیدها»، می‌توانید گواهینامه جدیدی بارگذاری کنید و گواهینامه منقضی را حذف کنید.

از «میاناهای برنامه‌سازی کاربردی هشدار» با هشدارهای انقضا استفاده کنید

بیشتر میاناهای برنامه‌سازی کاربردی که برای ایجاد و مدیریت هشدارهای انقضا استفاده می‌کنید همان‌هایی هستند که برای هشدارهای ثابت استفاده می‌کنید. «میاناهای برنامه‌سازی کاربردی» هشدار زیر برای هشدارهای ثابت و انقضایی به یک روش کار می‌کنند:

• دریافت هشدار - تعریف هشدار ثابت یا ناهنجاری را دریافت کنید.
• دریافت سابقه هشدار - سنجه‌های سابقه هشدار را دریافت کنید.
• حذف هشدار - تعریف هشدار ثابت یا ناهنجاری را حذف کنید.
• دریافت نمونه هشدار - اطلاعات مربوط به هشدار راه‌اندازی‌شده را دریافت کنید.
• دریافت تعداد هشدار - تعداد کل هشدارها را دریافت کنید.

بااین‌حال، برخی‌از «میاناهای برنامه‌سازی کاربردی» دارای دارایی‌های اضافی هستند که برای پشتیبانی از هشدارهای ناهنجاری استفاده می‌شوند، ازجمله:

• دریافت هشدارها - فهرست کردن همه هشدارها، ازجمله هشدارهای اصلاح‌شده و هشدارهای ناهنجاری.
• ایجاد هشدار - هشدار ثابت یا ناهنجاری ایجاد کنید.
• به‌روزرسانی هشدار - تعریف هشدار ثابت یا ناهنجاری را به‌روزرسانی کنید.

ایجاد یا به‌روزرسانی هشدار انقضا

از همان APIها برای ایجاد یا به‌روزرسانی هشدار انقضا استفاده کنید، همان‌طور که درحال‌حاضر برای هشدار ثابت انجام می‌دهید. بدنه فراخوانی API برای ایجاد یا به‌روزرسانی هشدار انقضا همانند هشدار ثابت است، با این تفاوت‌ها:

• برای مشخص کردن اینکه هشدار، هشدار انقضا است، باید دارایی‌های جدید زیر را اضافه کنید:

  "alertType": "cert"
  "alertSubType": "certfixed"

  مقادیر پیش‌فرض این دارایی‌ها عبارت‌اند از:

  "alertType": "runtime"
  "alertSubType": "fixed"

• در آرایه conditions:

  • دارایی metrics فقط مقادیر expiration را می‌پذیرد.
  • از دارایی gracePeriodSeconds برای مشخص کردن محدوده زمانی انقضای گواهینامه برحسب ثانیه استفاده کنید، حداکثر مدت ۳۰ روز.
  • از دارایی‌های threshold، durationSeconds، و comparator پشتیبانی نمی‌شود.
• در عنصر dimensions آرایه conditions:
  • باید مقدار خصوصیت certificate را روی ANY تنظیم کنید.
  • باید مقدار خصوصیت proxy را روی ALL تنظیم کنید.
  • ویژگی‌های statusCode،‏ developerApp،‏ collection،‏ faultCodeCategory، faultCodeSubCategory،‏ faultCodeName پشتیبانی نمی‌شود.
• دارایی reportEnabled برای هشدارهای انقضا پشتیبانی نمی‌شود.

فراخوانی API مثال زیر هشدار انقضایی ایجاد می‌کند که وقتی هر گواهینامه‌ای در محیط تولید در ۳۰ روز آینده منقضی شود راه‌اندازی می‌شود. وقتی هشدار راه‌اندازی می‌شود، اعلانی به نشانی ایمیل مشخص‌شده ارسال می‌شود:

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 مراجعه کنید.