कैटो एपीआई कॉल्स का समस्या निवारण

यह लेख एपीआई टूल्स और सॉफ़्टवेयर के साथ एपीआई क्वेरी चलाने के दौरान होने वाली सामान्य त्रुटियों के लिए समस्या निवारण सुझाव प्रदान करता है। उदाहरण के लिए, अल्टेयर और पोस्टमैन।

एपीआई स्क्रिप्ट्स और कोडिंग से संबंधित समस्याओं का समर्थन नहीं किया जाता है।

आवश्यक एपीआई तर्क

ये वे तर्क हैं जिन्हें एपीआई क्वेरी में शामिल करना आवश्यक है। जब आप एपीआई क्वेरी से वैकल्पिक तर्क को हटाते हैं, तो डिफ़ॉल्ट मान का उपयोग किया जाता है।

accountMetrics क्वेरी
- आईडी - खाता आईडी
- समय सीमा - डेटा की समय सीमा जो क्वेरी लौटाती है
- groupDevices - एकाधिक साइट्स और साइट्स के लिए जिनमें कई सॉकेट्स होते हैं, एनालिटिक्स को एकल सॉकेट में संयोजित करें (बूलियन मान true के लिए)
accountSnapshot क्वेरी
- आईडी - खाता आईडी

सामान्य GRAPHQL_PARSE_FAILED त्रुटियाँ

यह अनुभाग केटो GraphQL स्कीमा से संबंधित त्रुटि संदेशों के कुछ सामान्य उदाहरणों को समझाता है।

संदेश: अप्रत्याशित )

क्वेरी में एक अतिरिक्त कोष्ठक है। अक्सर यह त्रुटि होती है जब आप तर्क के लिए बूलियन मान नहीं देते हैं। उदाहरण के लिए, groupInterfaces: , की बजाय groupInterfaces: true,

संदेश: अपेक्षित नाम, मिला <character>

JSON फ़ाइल सही तरीके से स्वरूपित नहीं है। संदेश एक कैरेक्टर दिखाता है जो गायब या अतिरिक्त कैरेक्टर से संबंधित है। उदाहरण के लिए, Expected Name, found ( तर्क accountSnapshot((id: 42) के लिए। इस तर्क के लिए सही स्वरूप है accountSnapshot(id: 1941)

संदेश: अपेक्षित नाम, मिला <Invalid>

त्रुटि संदेश दर्शाता है कि एक अमान्य मान के साथ एक तर्क है।

उदाहरण के लिए, केटो एपीआई में timeFrame तर्क (accountMetrics) ISO 8601 तारीख और समय मानक के लिए उद्धरण चिह्नों का उपयोग करता है, timeFrame: "last.P1D" सही है और timeFrame: last.P1D इस त्रुटि को उत्पन्न करता है।

सामान्य GRAPH_QL_VALIDATION_FAILED त्रुटियाँ

यह अनुभाग क्वेरी में तर्कों के गलत स्वरूप से संबंधित त्रुटि संदेशों के कुछ सामान्य उदाहरणों को समझाता है।

संदेश: अपेक्षित प्रकार स्ट्रिंग!, पाया <number>

त्रुटि संदेश दर्शाता है कि एक तर्क में अमान्य मान है, आमतौर पर तर्क स्वरूप से संबंधित होता है।

उदाहरण के लिए, sites ids तर्क (accountMetrics > sites) एक स्ट्रिंग है, इसलिए आपको मान के लिए उद्धरण चिह्नों का उपयोग करना होगा, ids: ["4242"] सही है और ids:[4242] यह त्रुटि उत्पन्न करता है।

संदेश: अपेक्षित प्रकार Int!, पाया \"<number>\"

उदाहरण के लिए, sites ids तर्क (accountSnapshot > sites) एक INT है, इसलिए आपको मान के लिए उद्धरण चिह्नों का उपयोग नहीं करना चाहिए, ids: [2626] सही है और ids:["2626"] यह त्रुटि उत्पन्न करता है।

एपीआई त्रुटि संदेश

यह अनुभाग सामान्य त्रुटि संदेशों को समझाता है जो विशेष रूप से केटो GraphQL स्कीमा या स्वरूप से संबंधित नहीं हैं।

संदेश: प्रमाणीकरण त्रुटि या 403

आपके खाते के लिए एपीआई कुंजी में एक समस्या है। सुझाए गए समाधान:

कैटो प्रबंधन अनुप्रयोग में (सिस्टम > एपीआई एक्सेस प्रबंधन), सुनिश्चित करें कि:
- आप जो एपीआई कुंजी उपयोग कर रहे हैं वह अभी भी मान्य है (मौजूद है और समाप्त नहीं हुई है)
- यदि आईपी से पहुंच की अनुमति दें विकल्प सेट है, तो एपीआई क्लाइंट एक विशिष्ट अनुमत आईपी पते या रेंज से कॉल कर रहा है
पुष्टि करें कि कुंजी एपीआई क्वेरी सॉफ़्टवेयर के एचटीटीपी हेडर सेटिंग्स में सही तरीके से कॉन्फ़िगर की गई है: x-api-key: <key value>, उदाहरण के लिए, x-api-key: abcdef12345
अगर समस्या जारी रहती है, तो एक नई एपीआई कुंजी जनरेट करें और इसे एपीआई क्वेरी सॉफ़्टवेयर में जोड़ें

यह एपीआई क्लाइंट के लिए एक वैध एचटीटीपी हेडर का उदाहरण है:

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Accept: */*
Content-Type:application/json
x-api-key: abcdef123456789

संदेश: कई साइट्स का चयन करने पर डिवाइस को अलग नहीं किया जा सकता (groupDevices = false)

groupDevices तर्क (accountMetrics) का मान true होना चाहिए जब क्वेरी में कई साइट्स शामिल हों।

एपीआई एनालिटिक्स डेटा को परिवर्तित करना

कैटो एपीआई ट्रैफिक डेटा को बाइट्स में लौटाता है। डेटा को बड़े यूनिट्स में परिवर्तित करने के लिए (जैसे एमबी या जीबी), आपको 1024 के घातांक मूल्यों से विभाजित करना होगा: एमबी के लिए 1024², और जीबी के लिए 1024³।

उदाहरण के लिए, 536,870,912,000 बाइट्स को जीबी में बदलने के लिए, 1024³ से विभाजित करें ताकि 500GB डेटा दिख सके।