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

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

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

आवश्यक API तर्क

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

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

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

इस खंड में Cato GraphQL स्कीमा से संबंधित कुछ सामान्य त्रुटि संदेशों के उदाहरणों की व्याख्या की गई है।

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

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

संदेश: अपेक्षित नाम, पाया गया <वर्ण>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

संदेश: एकाधिक साइट्स चयनित होने पर उपकरण अलग नहीं कर सकते (groupDevices = false)

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

रखरखाव विंडो के दौरान स्क्रिप्ट चलाते समय सामान्य API त्रुटि

रखरखाव विंडो के दौरान (आमतौर पर हर दूसरे रविवार को), Cato API सर्वर को अपग्रेड करता है और यह अस्थायी रूप से दो मिनट तक उपलब्ध नहीं हो सकता है। यदि आप पुनरावर्ती API स्क्रिप्ट चला रहे हैं, तो रखरखाव विंडो के दौरान स्क्रिप्ट विफल हो सकती है और त्रुटि लौटा सकती है। आपके खाता डेटा पर कोई प्रभाव नहीं है।

अनुसूचित रखरखाव विंडो और Cato Cloud की स्थिति के बारे में अद्यतन जानकारी के लिए, https://status.catonetworks.com/ देखें।

API सर्वर के साथ टाइमआउट के लिए सामान्य API त्रुटि

यदि API क्वेरी के लिए 40 सेकंड से अधिक की देरी होती है, तो इसका मतलब है कि API सर्वर के साथ टाइमआउट हो गया है और आपको क्वेरी को फिर से चलाना होगा। हम अनुशंसा करते हैं कि आप अपने Cato खाते के लिए API स्क्रिप्ट के साथ पुनः प्रयास करें तंत्र शामिल करें। इस तंत्र को कम से कम दो पुनः प्रयासों को शामिल करना चाहिए और प्रत्येक प्रयास के बीच कम से कम 30 सेकंड तक प्रतीक्षा करनी चाहिए।