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

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

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

درباره گواهینامه‌های TLS

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

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

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

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

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

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

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

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

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

برای افزودن هشدارها و اعلان‌های انقضا:
  1. در رابط کاربری Edge، روی Analyze > Alert Rules کلیک کنید.
  2. روی +هشدار کلیک کنید.
  3. اطلاعات کلی زیر را در مورد هشدار وارد کنید:
    میدان توضیحات
    نام هشدار نام هشدار. از نامی استفاده کنید که محرک را توصیف کند و برای شما معنادار باشد. نام نمی‌تواند بیش از ۱۲۸ کاراکتر باشد.
    توضیحات شرح هشدار.
    نوع هشدار گزینه TLS Expiry را انتخاب کنید. برای اطلاعات بیشتر به «درباره انواع هشدار» مراجعه کنید.
    محیط زیست محیط مورد نظر را از لیست کشویی انتخاب کنید.
    وضعیت برای فعال یا غیرفعال کردن هشدار، آن را تغییر دهید.
  4. آستانه و بُعد شرایطی که باعث فعال شدن هشدار می‌شود را تعریف کنید.
    فیلد وضعیت توضیحات
    آستانه

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

    • ۱ روز
    • ۱۴ روز
    • ۳۰ روز
    ابعاد ابعاد به مقدار Any TLS Certificates مربوط به هر گواهی 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. اگر اعلانی اضافه کرده‌اید، فیلدهای زیر را تنظیم کنید:
    میدان توضیحات
    دفترچه راهنما (اختیاری) فیلد متنی آزاد برای ارائه توضیحی کوتاه از اقدامات توصیه‌شده برای رفع هشدارها هنگام فعال شدن. همچنین می‌توانید پیوندی به ویکی داخلی یا صفحه انجمن خود که در آن به بهترین شیوه‌ها اشاره می‌کنید، مشخص کنید. اطلاعات این فیلد در اعلان گنجانده خواهد شد. محتوای این فیلد نمی‌تواند بیش از ۱۵۰۰ کاراکتر باشد.
    دریچه گاز تعداد دفعات ارسال اعلان‌ها. از لیست کشویی، مقداری را انتخاب کنید.
  8. روی ذخیره کلیک کنید.

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

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

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

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

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

    • محیط زیست
    • منطقه
    • دوره زمانی
  3. برای بررسی بیشتر هشدار، یک ردیف در داشبورد رویداد انتخاب کنید تا Keystore حاوی گواهی منقضی شده نمایش داده شود. از صفحه 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، یک هشدار انقضا ایجاد می‌کند که زمانی فعال می‌شود که هر cery در محیط تولید در 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» مراجعه کنید.

هشدارهای انقضا را دریافت کنید

به طور پیش‌فرض، API مربوط به Get Alerts اطلاعات مربوط به تمام هشدارهای تعریف شده، چه هشدارهای ثابت و چه هشدارهای منقضی شده را برمی‌گرداند. این API اکنون پارامترهای پرس‌وجو را دریافت می‌کند تا به شما امکان فیلتر کردن نتایج را بدهد:

  • enabled - اگر true مشخص می‌کند که فقط هشدارهای فعال‌شده را برگرداند. مقدار پیش‌فرض false است.
  • alertType - نوع هشداری که باید برگردانده شود را مشخص می‌کند. مقادیر مجاز عبارتند از runtime ، default و 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» مراجعه کنید.