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

نظرة عامة على طلب API الأحداث

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

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

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

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

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

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

هذه هي الحجج التي يمكنك تمريرها إلى استدعاء API الأحداث لتعديل تشغيله:

  • معرِّف الحساب

  • القياسات

  • الفلاتر

  • الأبعاد

  • الفرز 

  • الإطار الزمني

وسيط accountID

هذا هو المعرِّف الحسابي الذي يتم تشغيل الاستعلام ضده.

ملاحظة

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

وسيط القياسات

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

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

  • نوع التجميع - يحدد كيفية تنفيذ التجميع (مثال: count_distinct)

يوضح المثال التالي صيغة القياسات للاستعلام الذي يعيد مجموع حقول event_count: 

 "قياسات": [
    {"اسم الحقل":"event_count","نوع التجميع":"المجموع"}
]

وسيط الفلاتر

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

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

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

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

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

"الفلاتر": [
    {
        "اسم الحقل": "نوع الحدث",        
         "المعامل": "هو",
         "القيم": ["الأمن"]
    }
]

وسيط الأبعاد

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

هنا مثال يجمع الملفات وفقًا لنوع الحدث:

"الأبعاد": [
    {"اسم الحقل": "نوع الحدث"}
]

وسيط الفرز

يحدد وسيط الفرز كيفية ترتيب البيانات المعادة.  هنا مثال على استخدام وسيط الفرز

  'الفرز': [ 
      {'اسم الحقل': 'event_count', 'الترتيب': 'desc'},
      {'اسم الحقل': 'event_type', 'الترتيب': 'asc'}
  ]

وسيط الإطار الزمني

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

"الإطار الزمني": "last.P30D" 

ملاحظة

ملاحظات:

  • الحد الأقصى للمدة الزمنية التي يمكن تحديدها لوسيط الإطار الزمني هو حاليًا 89 يومًا.

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

استعلام الأحداث النموذجي

استعلام نموذجي

استعلام الأحداث(
    $accountID: ID!,
    $measures: [EventsMeasure],
    $dimensions: [EventsDimension],
    $filters: [EventsFilter!],
    $sort: [EventsSort!],
    $timeFrame: TimeFrame!,
    $limit: Int,
    $from: Int) {  
    الأحداث(
        accountID: $accountID
        timeFrame: $timeFrame
        measures: $measures
        dimensions: $dimensions
        filters: $filters
        sort: $sort  ) {
        id    
        from
        total
        records(limit: $limit, from: $from) {
            fieldsMap
        }
    }
}

قيم المتغير

{  
    "معرّف الحساب": "1234",
    "القياسات": [ {
          "اسم الحقل": "نوع_الحدث_الفرعي",
          "نوع التجميع": "عدد_مميز"
          }
    ],
    "الفلاتر": [ {
          "اسم الحقل": "نوع_الحدث",
          "المعامل": "هو", "القيم": ["الأمن"]
          }  
    ],  
    "الإطار الزمني": "last.P1M"
}

إخراج الأحداث النموذجية

{  
    "البيانات": {
        "الأحداث": {
            "معرف": "xxx",
            "من": "2023-01-26T00:00:00Z",
            "إلى": "2023-02-27T00:00:00Z",
            "إجمالي": 1,
            "السجلات": [        
                 { 
                     "خريطة_الحقول": {          
                        "نوع_الحدث_الفرعي": "6"
                        }
                 }
             ]
        }
    }
}

هل كان هذا المقال مفيداً؟

0 من 0 وجدوا هذا مفيداً

لا توجد تعليقات