درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
از /metrics/events API برای دریافت همه رویدادهای سازمان در بازه زمانی مشخص استفاده کنید. فهرست رویدادها شامل همه هشدارهای شناساییشده توسط 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-ddThh:mm:ssZyyyy-mm-ddThh:mm:ss+00:00
برای مثال:
now- -
1h -10min2019-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"
$ACCESS_TOKEN را روی کد دسترسی OAuth 2.0 تنظیم کنید، همانطور که در دریافت کد دسترسی OAuth 2.0 توضیح داده شده است. برای اطلاعات درباره گزینههای curl استفادهشده در این مثال، استفاده از curl را ببینید.
این API از پارامترهای اختیاری پُرسمان زیر پشتیبانی میکند:
| نام | شرح | پیشفرض |
|---|---|---|
from
|
ابتدای بازه زمانی که هشدارها باید برای آن واکشی شوند. مقدار پیشفرض زمان کنونی منهای یک ساعت است. شرح بالا را درباره تنظیم این پارامتر ببینید. | ۱- ساعت |
to
|
پایان بازه زمانی که هشدارها باید برای آن واکشی شوند. مقدار پیشفرض زمان کنونی است. شرح بالا را درباره تنظیم این پارامتر ببینید. | اکنون |
alertId
|
نتایج سابقه هشدار را براساس شناسه تعریف هشدار مشخصشده فیلتر کنید. | همه شناسههای هشدار |
env
|
رویدادها را براساس محیط مشخصشده فیلتر کنید. | همه محیطها |
name
|
رویدادها را براساس نام هشدار مشخصشده فیلتر کنید. | همه نامهای هشدار |
region
|
رویدادها را براساس منطقه مشخصشده فیلتر کنید. | همه مناطق |
type
|
رویدادها را براساس نوع مشخصشده فیلتر کنید: alert.
|
همه انواع |