Cato للقراءة فقط API - الأحداث

نظرة عامة على استعلام API للأحداث

يوفر استعلام API للأحداث وسيلة للحصول على معلومات ملخصة عن الأحداث المولدة لحساب ما بدون الحاجة لاستخراج الأحداث الفردية أولاً وإجراء التحليل.  

أمثلة على نوع التحليل الذي يشمله API للأحداث تشمل:

• عدد مستخدمي SDP الذين سجلوا الدخول خلال فترة زمنية محددة

• نسبة أحداث الحظر إلى السمح في جدار الحماية

• إظهار عدد الأحداث (الفرق) التي تم توليدها لكل نوع حدث خلال الثلاثين يومًا الماضية

الوسائط للأحداث

هذه هي الوسائط التي يمكنك تمريرها إلى مكالمة API للأحداث لتعديل تشغيلها:

• accountID

• measures

• filters

• dimensions

• الترتيب 

• timeFrame

الحجة accountID

هذا هو accountID للحساب الذي تقوم بتشغيل الاستعلام عليه.

تنويه:

معرف الحساب هذا غير ظاهر في تطبيق إدارة كاتو، بدلاً من ذلك، هو الرقم الموجود في عنوان URL لتطبيق إدارة كاتو. على سبيل المثال، معرف الحساب هو ٢٦ لعنوان URL التالي: https://cc.catonetworks.com/#!/26/topology.

الحجة measures

تتيح لك الحجة measures تحديد الحقول التي تريد أن يفحصها استعلام events والطريقة التي يجب تجميع النتائج بها. لكل حقل تريد تحليله، يجب تحديد ما يلي: 

• fieldName - يحدد الحقل الذي تريد تجميعه

• aggType - يحدد كيفية إجراء عملية التجميع (مثل count_distinct)

يوضح المثال التالي بناء جملة measures لاستعلام يعيد مجموع حقول event_count: 

 "measures": [
   {"fieldName":"event_count","aggType":"sum"}
]

الحجة filters

تتيح لك الحجة filters تحديد فلتر يؤدي إلى فحص جزء محدود فقط من الأحداث. لكل فلتر يجب تحديد ما يلي:

• fieldName - يحدد اسم الحقل الذي تريد تصفيته

• operator - يحدد عملية التصفية التي يجب استخدامها لتصفية الحقل

• values - يحدد قيمة الفلتر التي تستخدم مع العملية

إليك مثال على استخدام الحجة filters لاختيار فقط الأحداث التي نوعها أمني:

"filters": [
    {
        "fieldName": "event_type",        
         "operator": "is",
         "values": ["أمان"]
    }
]

الحجة dimensions

استخدم الحجة dimensions لتجميع الحقول ذات القيم المتطابقة في صفوف ملخصة.

إليك مثال يجمع الملفات حسب نوع الحدث:

"dimensions": [
   {"fieldName": "event_type"}
]

الحجة sort

تحدد الحجة sort كيفية ترتيب البيانات المعادة. إليك مثالاً على استخدام الحجة sort

  'sort': [
   {'fieldName': 'event_count', 'order': 'desc'},
   {'fieldName': 'event_type', 'order': 'asc'}
 ]

الحجة timeFrame

يحدد إطار زمني timeframe للاستعلام.  تم تحديد ذلك باستخدام التنسيق المحدد من قبل مواصفات ISO 8601. إليك مثالاً على كيفية تحديد الإطار الزمني للأيام الثلاثين الماضية:

"timeFrame": "last.P30D" 

ملاحظات:

• الحد الأقصى لمدة الوقت التي يمكن تحديدها للحجة timeFrame هو حاليًا 89 يومًا.

• يمكن الحصول على المواصفة الفعلية ISO 8601 هنا، ولكنها غير مجانية. يمكنك أيضًا الرجوع إلى هذا المقال على ويكيبيديا للحصول على مزيد من المعلومات لفهم كيفية تحديد هذه الحجة.

عينة استعلام الأحداث

عينة استعلام

query events(
   $accountID: ID!,
   $measures: [EventsMeasure],
   $dimensions: [EventsDimension],
   $filters: [EventsFilter!],
   $sort: [EventsSort!],
   $timeFrame: TimeFrame!,
   $limit: Int,
   $from: Int) { 
   events(
      accountID: $accountID
      timeFrame: $timeFrame
      measures: $measures
      dimensions: $dimensions
      filters: $filters
      sort: $sort ) {
      id 
      from
      total
      records(limit: $limit, from: $from) {
         fieldsMap
      }
   }
}

قيم المتغيرات

{  
    "accountID": "1234",
    "measures": [ {
          "fieldName": "event_sub_type",
          "aggType": "count_distinct"
          }
    ],
    "filters": [ {
          "fieldName": "event_type",
          "operator": "is", "values": ["أمان"]
          }  
    ],  
    "timeFrame": "last.P1M"
}

عينة مخرجات الأحداث

{ 
   "data": {
      "events": {
         "id": "xxx",
         "from": "2023-01-26T00:00:00Z",
         "to": "2023-02-27T00:00:00Z",
         "total": 1,
         "records": [ 
            { 
               "fieldsMap": { 
                  "event_sub_type": "6"
               }
            }
         ]
      }
   }
}