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

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

از API /metrics/events برای دریافت تمام رویدادهای یک سازمان در یک بازه زمانی مشخص استفاده کنید. لیست رویدادها شامل تمام هشدارهای شناسایی شده توسط Edge است.

به طور پیش‌فرض، API تمام رویدادهای ساعت قبل را برمی‌گرداند. از پارامترهای کوئری from و to برای تعیین مدت زمان متفاوت استفاده کنید. مقادیر پارامترهای کوئری from و to از قالب‌های زیر پشتیبانی می‌کنند:

  • now (به وقت محلی فعلی)
  • -< value >< unit > زمانی را در گذشته مشخص می‌کند (به خط تیره ابتدای عبارت توجه کنید):
    • < value > – یک عدد صحیح
    • < unit > – یکای زمان: s, sec, second, m, min, minute, h, hr, hour, d, day
  • یک تاریخ با فرمت ISO به یکی از صورت‌های زیر:
    • yyyy-mm-dd T hh:mm:ss Z
    • yyyy-mm-dd T hh:mm:ss+00:00

برای مثال:

  • now
  • - 1h
  • -10min
  • 2019-05-13T14:04:00+00:00

فقط پارامتر کوئری org مورد نیاز است. فراخوانی API زیر تمام رویدادهای سازمان myorg را برای ۱۲ ساعت گذشته برمی‌گرداند:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"

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

این API از پارامترهای پرس‌وجوی اختیاری زیر پشتیبانی می‌کند:

نام توضیحات پیش‌فرض
from شروع بازه زمانی که هشدارها باید برای آن دریافت شوند. مقدار پیش‌فرض، زمان فعلی منهای یک ساعت است. برای تنظیم این پارامتر به توضیحات بالا مراجعه کنید. -1 ساعت
to پایان بازه زمانی که هشدارها باید برای آن دریافت شوند. مقدار پیش‌فرض، زمان فعلی است. برای تنظیم این پارامتر به توضیحات بالا مراجعه کنید. الان
alertId نتایج تاریخچه هشدار را بر اساس شناسه تعریف هشدار مشخص شده فیلتر کنید. همه شناسه‌های هشدار
env رویدادها را بر اساس محیط مشخص شده فیلتر کنید. همه محیط‌ها
name رویدادها را بر اساس نام هشدار مشخص شده فیلتر کنید. همه نام‌های هشدار
region رویدادها را بر اساس منطقه مشخص شده فیلتر کنید. همه مناطق
type رویدادها را بر اساس نوع مشخص شده فیلتر کنید: alert . همه انواع