هشدارهای انقضا را تنظیم کنید

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

از یک هشدار انقضای TLS استفاده کنید تا زمانی که گواهی TLS در یک محیط منقضی می شود، اعلان ارسال کنید.

درباره گواهی های TLS

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

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

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

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

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

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

می توانید هشدار انقضا را تنظیم کنید تا رخ دهد:

  • 1 روز قبل از انقضای هر گواهی
  • 14 روز قبل از انقضای هر گواهی
  • 30 روز قبل از انقضای هر گواهی
برای اطلاعات بیشتر درباره هشدارها، به تنظیم هشدارها و اعلان‌ها مراجعه کنید.

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

برای افزودن هشدارها و اعلان های انقضا:
  1. روی Analyze > Alert Rules در Edge UI کلیک کنید.
  2. روی +Alert کلیک کنید.
  3. اطلاعات کلی زیر را در مورد هشدار وارد کنید:
    میدان توضیحات
    نام هشدار نام هشدار از نامی استفاده کنید که محرک را توصیف کند و برای شما معنادار باشد. نام نمی تواند بیش از 128 کاراکتر باشد.
    توضیحات شرح هشدار
    نوع هشدار TLS Expiry را انتخاب کنید. برای اطلاعات بیشتر درباره انواع هشدارها را ببینید.
    محیط زیست محیط را از لیست کشویی انتخاب کنید.
    وضعیت برای فعال یا غیرفعال کردن هشدار، آن را تغییر دهید.
  4. آستانه و بعد را برای شرایطی که هشدار را راه‌اندازی می‌کند، تعریف کنید.
    فیلد وضعیت توضیحات
    آستانه

    محدوده زمانی را برای گواهی های در حال انقضا پیکربندی کنید. می‌توانید انتخاب کنید زمانی که یک گواهی منقضی می‌شود، هشداری در این مورد ایجاد کنید:

    • 1 روز
    • 14 روز
    • 30 روز
    بعد ابعاد به مقدار هر گواهی TLS مربوط به هر گواهی TLS در محیط ثابت است.
  5. برای افزودن یک اعلان هشدار، روی + Notification کلیک کنید.
    جزئیات اعلان توضیحات
    کانال کانال اطلاع رسانی را که می خواهید استفاده کنید انتخاب کنید و مقصد را مشخص کنید: Email، Slack، PagerDuty یا Webhook.
    مقصد مقصد را بر اساس نوع کانال انتخابی مشخص کنید:
    • ایمیل - آدرس ایمیل، مانند joe@company.com
    • Slack - URL کانال شل، مانند https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - کد PagerDuty، مانند abcd1234efgh56789
    • Webhook - URL Webhook، مانند https://apigee.com/test-webhook

      توجه : در هر اعلان می توانید فقط یک مقصد را مشخص کنید. برای تعیین چندین مقصد برای یک نوع کانال، اعلان‌های اضافی اضافه کنید.

  6. برای افزودن اعلان های اضافی، مرحله قبل را تکرار کنید.
  7. اگر اعلانی اضافه کردید، فیلدهای زیر را تنظیم کنید:
    میدان توضیحات
    کتاب بازی (اختیاری) فیلد متنی فرم آزاد برای ارائه شرح کوتاهی از اقدامات توصیه شده برای حل هشدارها هنگام شلیک. همچنین می‌توانید پیوندی به ویکی داخلی یا صفحه انجمن خود که در آن به بهترین شیوه‌ها اشاره می‌کنید، مشخص کنید. اطلاعات این قسمت در اطلاعیه درج خواهد شد. محتوای این فیلد نمی تواند بیش از 1500 کاراکتر باشد.
    دریچه گاز فرکانس ارسال اعلان ها یک مقدار را از لیست کشویی انتخاب کنید.
  8. روی ذخیره کلیک کنید.

هشدارها را در داشبورد رویدادها مشاهده کنید

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

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

  1. روی Analyze > Events در Edge UI کلیک کنید. داشبورد رویدادهای جدید ظاهر می شود:

  2. داشبورد رویدادها را بر اساس:

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

از 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 مثال زیر یک هشدار انقضا ایجاد می‌کند که زمانی فعال می‌شود که هر سر در محیط پرود در 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
}'

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN را روی نشانه دسترسی 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'

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN را روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید. برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.