केटो केवल पढ़ें एपीआई - घटनाएँ

घटना एपीआई प्रश्न का अवलोकन

घटनाएँ एपीआई प्रश्न खाता के लिए उत्पन्न घटनाओं के बारे में संक्षेप जानकारी प्राप्त करने का एक तरीका प्रदान करता है बिना पहले व्यक्तिगत घटनाओं को निकालने और विश्लेषण करने की आवश्यकता के।  

घटनाएँ एपीआई में शामिल विश्लेषण के प्रकार के उदाहरण:

• एक विशिष्ट समय सीमा के दौरान लॉगिन करने वाले एसडीपी उपयोगकर्ताओं की संख्या

• फ़ायरवॉल ब्लॉक बनाम अनुमति घटनाओं का प्रतिशत

• पिछले 30 दिनों में प्रत्येक घटना प्रकार के लिए उत्पन्न घटनाओं की संख्या (कार्डिनैलिटी) दिखाएं

घटनाओं के लिए तर्क

ये वे तर्क हैं जिन्हें आप घटनाओं एपीआई कॉल को पारित कर सकते हैं इसकी ऑपरेशन को संशोधित करने के लिए:

• खाताID

• माप

• फ़िल्टर

• आयाम

• क्रमबद्ध करें 

• समय सीमा

खाताID तर्क

यह खाताID है जिसके खिलाफ आप क्वेरी चला रहे हैं।

Note:

यह खाता आईडी Cato प्रबंधन अनुप्रयोग में नहीं दिखाया गया है, बल्कि यह Cato प्रबंधन अनुप्रयोग के लिए यूआरएल में संख्या है।  उदाहरण के लिए, निम्नलिखित यूआरएल के लिए खाता आईडी 26 है: https://cc.catonetworks.com/#!/26/topology।

माप तर्क

माप तर्क आपको उन फ़ील्ड्स को परिभाषित करने देता है जिन्हें आप घटनाएं क्वेरी से जांचना चाहते हैं और परिणामों को कैसे एकत्रित करना चाहिए। प्रत्येक फ़ील्ड के लिए जिसे आप विश्लेषण करना चाहते हैं, आपको निम्नलिखित परिभाषित करना होगा: 

• फ़ील्ड नाम - उस क्षेत्र को परिभाषित करता है जिसे आप संगठित करना चाहते हैं

• एकत्रित प्रकार - परिभाषित करता है कि आप संगठितीकरण को कैसे सम्पन्न करना चाहते हैं (जैसे कि count_distinct)

निम्नलिखित उदाहरण माप सिंटैक्स को दर्शाता है एक क्वेरी जो event_count क्षेत्रों के योग को लौटाता है: 

 "माप": [
    {"fieldName":"event_count","aggType":"sum"}
]

फिल्टर्स तर्क

फिल्टर्स तर्क आपको फ़िल्टर को परिभाषित करने देता है जो केवल घटनाओं के सीमित उपसमुच्चय के परीक्षा के परिणामस्वरूप होता है। प्रत्येक फ़िल्टर के लिए आपको निम्नलिखित परिभाषित करना होगा:

• फ़ील्ड नाम - उस क्षेत्र के नाम को परिभाषित करता है जिसे आप फिल्टर करना चाहते हैं

• ऑपरेटर - फ़िल्टर ऑपरेशन को परिभाषित करता है जिसे क्षेत्र को फिल्टर करने के लिए उपयोग किया जाना चाहिए

• मान - फ़िल्टर मान को परिभाषित करता है जो ऑपरेटर के साथ उपयोग किया जाता है

निम्नलिखित उदाहरण सुरक्षा के घटना प्रकार के साथ केवल घटनाओं का चयन करने के लिए फिल्टर्स तर्क को उपयोग में लेता है:

"फिल्टर": [
    {
        "fieldName": "event_type", 
        "operator": "is",
        "values": ["सुरक्षा"]
    }
]

आयाम तर्क

आयाम तर्क का उपयोग समान मानों के साथ फ़ील्ड्स को सारांश पंक्तियों में समूहित करने के लिए करें।

यहां एक उदाहरण है जो event_type के अनुसार फ़ाइलों को समूहित करता है:

"आयाम": [
    {"fieldName": "event_type"}
]

क्रमबद्ध करें तर्क

क्रमबद्ध करें तर्क परिभाषित करता है कि लौटाए गए डेटा को कैसे क्रमबद्ध किया जाना है।  यहां क्रमबद्ध करें तर्क का उपयोग का एक उदाहरण है

  'क्रमबद्ध करें': [ 
      {'fieldName': 'event_count', 'order': 'desc'},
      {'fieldName': 'event_type', 'order': 'asc'}
  ]

समय सीमा तर्क

क्वेरी के समय सीमा को परिभाषित करता है। यह ISO 8601 विशिष्टता द्वारा परिभाषित प्रारूप का उपयोग करके निर्दिष्ट किया गया है। पिछले 30 दिनों के लिए समय सीमा निर्दिष्ट करने का एक उदाहरण यहां है:

"समय सीमा": "last.P30D" 

नोट्स:

• समय सीमा तर्क के साथ वर्तमान में निर्दिष्ट किया जा सकने वाली समय की अधिकतम लंबाई 89 दिन है।

• आईएसओ 8601 विनिर्देश यहां प्राप्त किया जा सकता है, लेकिन यह मुफ़्त नहीं है।  इस तर्क को परिभाषित करने का तरीका समझने के लिए आप इस विकिपीडिया लेख का भी संदर्भ ले सकते हैं।

उदाहरण घटनाएँ प्रश्न

उदाहरण प्रश्न

{ 
    "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"
                    }
                }
            ]
        }
    }
}

उदाहरण घटनाएँ आउटपुट

{
   "डेटा": {
       "घटनाएँ": {
           "आईडी": "xxx",
           "से": "2023-01-26T00:00:00Z",
           "किसी की ओर": "2023-02-27T00:00:00Z",
           "कुल": 1,
           "रिकॉर्ड": [
               {
                   "फील्ड्समैप": {
                       "इवेंट_sub_type": "6"
                   }
               }
           ]
       }
   }
}