نوصي بشدة أن يتم مراجعة سياسة الدعم لواجهة برمجة التطبيقات الخاصة بـCato قبل البدء باستخدامها.
نظرة عامة على eventsFeed
استعلام eventsFeed يساعدك على تحليل الأحداث الناتجة عن الأنشطة المتعلقة بالشبكات والأمان والمآخذ وعملاء Cato والمزيد. بيانات الحدث التي يُرجعها هذا الاستعلام مشابهة لصفحة المراقبة > الأحداث في تطبيق إدارة Cato.
لحسابات الموزعين، يمكنك إنشاء مفاتيح API منفصلة داخل كل حساب عميل تتصل بـ Cato API. للمزيد حول الحد من المعدل واستعلام واجهة برمجة التطبيقات لتغذية الأحداث، انظر فهم الحد من معدل واجهة برمجة تطبيقات Cato.
فهم الأحداث المحملة
تم تصميم استدعاء واجهة برمجة التطبيقات لتغذية الأحداث لتحليل ومراقبة الأحداث بحجم كبير في حسابك. يتم تحديث البيانات لهذا استعلام API في الوقت القريب من الحقيقي.
تحتفظ Cato ببيانات الأحداث لآخر ثلاثة أيام. كل 24 ساعة، يتم حذف البيانات التي مضى عليها أكثر من ثلاثة أيام.
هذه الحقول تتعلق بالتقسيم لصفحات الأحداث: marker وfetchedCount. انظر أدناه للحصول على تفسيرات لهذه الحقول.
تمكين eventsFeed لحسابك
استخدم نافذة إدارة وصول API لتمكين حسابك من إرسال الأحداث إلى خادم Cato API. بعد تمكين eventsFeed، انتظر حوالي 30 دقيقة لخادم API ليجمع ما يكفي من الأحداث لإرجاع البيانات للاستعلام.
لتمكين eventsFeed لحسابك:
- في لوحة التنقل، اختر الإدارة > API & التكاملات وانقر على علامة تبويب تكامل الأحداث.
- اختر تمكين التكامل مع أحداث Cato. يبدأ حسابك في إرسال الأحداث إلى خادم Cato API.
تفاصيل حقول eventsFeed
هذه هي التفاصيل التي يمكن لحقول eventsFeed عرضها للاستعلام:
- marker - حقل marker هو معرف فريد لآخر حدث أعاده استعلام API
- fetchedCount - عدد الأحداث المحملة (بحد أقصى 3000 حدث لكل تحميل)
- accounts (eventsFeedAccountRecords) - بيانات الأحداث للحساب (مجموعة مع استعلامات وحقول متداخلة)
معرف marker لـ eventsFeed
عندما يكون هناك أكثر من 3000 حدث في طابور خادم API، يظهر حقل Marker معرّف يشير إلى بداية تكرار جديد لجلب الأحداث. على سبيل المثال، إذا أعاد الاستعلام 7500 حدث، فإن النتائج على مدى التكرارات ستكون كالتالي:
- التكرار الأول - fetchedCount = 3000 (الأحداث)، marker = 1234abc
- التكرار الثاني - fetchedCount = 3000 (الأحداث)، marker = 4567def
-
التكرار الثالث - fetchedCount = 1500 (الأحداث)، المؤشر = 8901xyz
يمكنك تجاهل قيمة المؤشر في التكرار النهائي.
يمكن للمؤشرات أن تشير إلى طابور الأحداث لغاية الثلاثة أيام السابقة.
عدد الأحداث المحملة من eventsFeed
يُظهر حقل fetchedCount العدد الإجمالي للأحداث في عملية الجلب الحالية. القيمة القصوى لهذا الحقل هي 3000.
حسابات eventsFeed
الحقول (eventsFeedAccountRecords) تظهر معرفات الحساب وبيانات الأحداث لهذا الاستعلام. استخدم عوامل eventsFeedAccountsRecords > EventRecord > EventFieldName لتصفية بيانات الحدث المعروضة للاستعلام. للمزيد حول سجلات الحدث، انظر واجهة برمجة التطبيقات الخاصة بـ Cato - تغذية الأحداث > سجل الحدث.
eventsFeed > السجلات > EventFieldName
لمزيد من المعلومات حول قيم التعداد EventFieldName لأنواع الأحداث المختلفة، انظر مرجع API لـ Cato Networks GraphQL.
المعطيات لـ eventsFeed
هذه هي المعطيات التي يمكنك تمريرها وتحديد البيانات التي يتم إرجاعها بواسطة الاستعلام:
- accountIDs - معرفات الحساب (لعدة حسابات، أدخل المعرفات كمصفوفة)
- الفلاتر (EventFieldFilterInput) - تصفية بيانات الحدث وسجل التدقيق التي يتم استجوابها (مصفوفة مع استعلامات متداخلة)
- marker - عرض الأحداث فقط لتكرار جلب محدد حسب قيمة المعرّف
معطى معرف eventsFeed
أدخل واحدًا أو أكثر من معرفات حساب Cato للبيانات التي يُرجعها الاستعلام. هذا المعطى إلزامي.
هذا معرف الحساب غير معروض في تطبيق إدارة Cato، بدلاً من ذلك هو الرقم الموجود في عنوان URL لتطبيق إدارة Cato. على سبيل المثال، معرف الحساب هو 26 للعنوان التالي: https://cc2.catonetworks.com/#!/26/topology.
معطى فلاتر eventsFeed
المصطلح (EventFieldFilterInput) يتيح لك تحديد الأحداث المحددة التي يتم تضمينها في الاستعلام. هذه هي المعطيات التي يمكنك تحديدها:
- fieldName > EventFeedFilterFieldName - حدد نوع الحدث أو الفئة الفرعية من استكشاف الأحداث
- المشغل - حدد كيفية تنشيط القيم لتصفية بيانات الحدث
- القيم - حدد قيمة المرشح التي تستخدم مع المشغل
التركيب التالي للمرشح هو مثال على استعلام تم تصفيته لعرض أنواع الأحداث بالقيمة الأمان:
"filters": [
{
"fieldName": "event_type",
"operator": "is",
"values": ["الأمان"]
}
]التركيب التالي للمرشح هو مثال لاستعلام تم تصفيته لعرض أنواع الأحداث الفرعية فقط بالقيمة جدار الحماية الإنترنت:
"filters": [
{
"fieldName": "event_sub_type",
"operator": "is",
"values": ["جدار الحماية للإنترنت"]
}
]معطى معرّف eventsFeed
المعطى المعرّف إلزامي ويسمح لك بتحديد الاستعلام إلى الأحداث لتكرار جلب محدد. على سبيل المثال، إذا أعاد الاستعلام 10500 حدث، فإن هذه هي النتائج على مدار أول ثلاث تكرارات جلب:
- التكرار الأول - fetchedCount = 3000 (الأحداث)، marker = 1234abc
- التكرار الثاني - fetchedCount = 3000 (الأحداث)، marker = 4567def
- التكرار الثالث - fetchedCount = 3000 (الأحداث)، marker = 8901xyz
لعرض الأحداث في التكرار الثاني فقط، قم بتعيين المعرّف إلى 4567def.
لجلب جميع الأحداث المدرجة في الانتظار، قم بتشغيل الاستعلام بمعطى معرف فارغ (marker:"") مع الاستعلام الأولي لـ GraphQL.
لا توجد تعليقات
الرجاء تسجيل الدخول لترك تعليق.