Cato API कॉल्स का समस्या निवारण

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

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

आवश्यक API तर्क

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

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

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

यह अनुभाग कुछ सामान्य उदाहरणों के लिए त्रुटि संदेश की व्याख्या करता है जो Cato GraphQL schema से संबंधित होते हैं।

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

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

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

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

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

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

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

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

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

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

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

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

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

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

API त्रुटि संदेश

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

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

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

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

यह API क्लाइंट के लिए एक मान्य HTTP हेडर का उदाहरण है:

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 होना चाहिए जब क्वेरी में कई साइट्स शामिल होती हैं।

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

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

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