Cato API क्या है

यह लेख आपको Cato API के साथ शुरू करने में मदद करता है ताकि आप अपने खाते में सेटिंग्स और वस्तुओं की निगरानी और कॉन्फ़िगर कर सकें।

अवलोकन

Cato API Cato Cloud के साथ निर्बाध एकीकरण के लिए प्राथमिक स्वचालन इंटरफ़ेस है। Cato API का उपयोग करके कुशल संचालन मूल कार्यप्रवाह जैसे तैनाती और कॉन्फ़िगरेशन सेट अप करें, साथ ही व्यापक स्थिति निगरानी, सांख्यिकी और डेटा संग्रह और विश्लेषण अपने नेटवर्क और सुरक्षा प्रबंधन को सुगम करने के लिए करें।

Cato API एंडपॉइंट और स्कीमा

API एंडपॉइंट और स्कीमा के लिए URL उस स्थान के लिए विशिष्ट है जहां Cato प्रबंधन अनुप्रयोग (CMA) उदाहरण होस्ट किया गया है। एक <prefix> मान हो सकता है जिसे आपके CMA खाते के URL और API एंडपॉइंट और स्कीमा में जोड़ा जाता है।

API एंडपॉइंट का URL इस प्रारूप में है, https://api.<prefix>.catonetworks.com/api/v1/graphql2.

API स्कीमा के लिए URL इस प्रारूप में है, https://api.<prefix>.catonetworks.com/api/schema.

API एंडपॉइंट के लिए URL

यदि कोई प्रिफिक्स नहीं है (cc.catonetworks.com), तो निम्नलिखित URL का उपयोग करें: https://api.catonetworks.com/api/v1/graphql2
यदि एक प्रिफिक्स है (जैसे cc.us1.catonetworks.com), तो आप निम्नलिखित URL का उपयोग करेंगे (विभिन्न स्थानों के लिए प्रिफिक्स को संशोधित करें): https://api.us1.catonetworks.com/api/v1/graphql2

API स्कीमा के लिए URL

यदि कोई प्रिफिक्स नहीं है (cc.catonetworks.com), तो निम्नलिखित URL का उपयोग करें: https://api.catonetworks.com/api/schema
यदि एक प्रिफिक्स है (जैसे cc.us1.catonetworks.com), तो आप निम्नलिखित URL का उपयोग करेंगे (विभिन्न स्थानों के लिए प्रिफिक्स को संशोधित करें): https://api.us1.catonetworks.com/api/schema

API स्कीमा प्रलेखन

Cato API GraphQL पर निर्मित हैं, जो RESTful API उपकरणों और ग्राहकों के साथ पूर्ण संगतता के साथ एक सहज इंटरफ़ेस प्रदान करता है। GraphQL अतिरिक्त लचीलापन देता है कि आप ठीक वही डेटा क्वेरी कर सकते हैं जिसकी आपको आवश्यकता है, ओवर-फेचिंग को कम करता है और दक्षता में सुधार करता है।

Cato Networks GraphQL API संदर्भ पर Cato API दस्तावेज़ उपलब्ध है, जिसमें शामिल है:

स्कीमा परिभाषा और प्रलेखन
उदाहरण API कॉल और संबंधित नमूना प्रतिक्रियाएं
API के अन्वेषण और परीक्षण के लिए एक इंटरैक्टिव प्लेग्राउंड के साथ GraphQL API एंडपॉइंट

API जीवनचक्र

यह अनुभाग विभिन्न जीवनचक्र चरणों का वर्णन करता है जो एक विशिष्ट API के परिपक्वता स्तर और उपलब्धता पर आधारित हैं।

प्रत्येक नई API प्रारंभिक रूप से बीटा चरण में जारी की जाती है। बीटा से GA में संक्रमण आंतरिक समीक्षा और विचार के अधीन है यह सत्यापित करने के लिए कि API स्थिर और उत्पादन के लिए तैयार है। आमतौर पर, बीटा से GA में संक्रमण में लगभग एक वर्ष लगता है।

टिप्पणी

टिप्पणी: नीचे वर्णित जीवनचक्र केवल उन औपचारिक Cato API को संदर्भित करता है जो Cato Networks GraphQL API संदर्भ में परिभाषित हैं। यह किसी भी अतिरिक्त उपकरणों और नमूनों को शामिल नहीं करता जो संदर्भ के रूप में प्रदान किए जा सकते हैं।

उदाहरण के लिए, यह Cato GitHub खाता पर उपलब्ध ओपन-सोर्स उदाहरणों और उपयोगिताओं को शामिल नहीं करता। ये संसाधन "जैसा है" प्रदान किए जाते हैं बिना किसी वारंटी या आगे के विकास, रखरखाव, या समर्थन के दायित्व के।

API परिपक्वता स्तर

ये API जीवनचक्र के चरण के हिस्से के रूप में परिपक्वता स्तर हैं:

बीटा: बीटा चरण में API फीचर-कम्पलीट और पूर्ण रूप से संचालित होती हैं, जिससे वे उत्पादन वातावरण में उपयोग के लिए उपयुक्त बनती हैं। हालांकि, वे उपयोगकर्ता की प्रतिक्रिया या अन्य विचारों के आधार पर परिवर्तनों का अनुभव कर सकते हैं। ये परिवर्तन, API स्कीमा में तोड़ने वाले परिवर्तन सहित, छोटी सूचना के साथ हो सकते हैं और क्लाइंट कोड के अद्यतन की आवश्यकता हो सकती है।
GA (सामान्य उपलब्धता): GA में API स्थिर, उत्पादन-तैयार होती हैं, और पिछली अनुकूलता के प्रति प्रतिबद्धताओं और दीर्घकालिक समर्थन के साथ आती हैं। API स्कीमा में तोड़ने वाले परिवर्तन दुर्लभ होते हैं और क्लाइंट कोड समायोजन के लिए पर्याप्त समय देने के लिए पूर्व-सूचना दी जाती है।

जिन API को स्पष्ट रूप से बीटा के रूप में लेबल नहीं किया गया है, उन्हें GA माना जाता है। कुछ मामलों में, एक GA API के भीतर, व्यक्तिगत फ़ील्ड्स, प्रकार और इनपुट्स को बीटा के रूप में चिह्नित किया जा सकता है।

API उपलब्धता स्तर

ये जीवनचक्र स्तर के हिस्से के रूप में API की उपलब्धता स्तर हैं:

EA (प्रारंभिक उपलब्धता): EA में API व्यापक रिलीज़ से पहले परीक्षण और प्रतिक्रिया के लिए उपयोगकर्ताओं के सीमित समूह को उपलब्ध हैं। प्रवेश के लिए विशेष अनुमोदन या परिस्थितियाँ आवश्यक हो सकती हैं।
धीरे-धीरे रोलआउट: क्लाउड-आधारित सेवाओं के लिए मानक उद्योग सर्वोत्तम प्रथाओं का पालन करते हुए, Cato API धीरे-धीरे जारी किए जाते हैं ताकि स्थिरता सुनिश्चित की जा सके और प्रदर्शन की निगरानी की जा सके, और समय के साथ सभी खातों के लिए उपलब्धता विस्तारित होती है।

जिन API को EA या धीरे-धीरे रोलआउट के रूप में चिह्नित नहीं किया गया है, उन्हें पूरी तरह से लागू और सभी उपयोगकर्ताओं के लिए सुलभ माना जाता है।

API लेबल के सारांश

यह अनुभाग प्रलेखन में परिपक्वता और उपलब्धता स्तर के आधार पर API के लेबल का सारांश प्रस्तुत करता है।

जिन API में कोई लेबल नहीं है, वे सभी खातों के लिए पूरी तरह से उपलब्ध हैं और स्कीमा में तोड़ने वाले परिवर्तनों की संभावना दुर्लभ होती है। किसी भी ऐसे परिवर्तन की birkaç महीने पहले घोषणा की जाएगी। इन परिवर्तनों के बारे में अधिक देखने के लिए, नीचे देखें संभावित तोड़ने वाले स्कीमा परिवर्तन.

EA
- केवल Cato के EA प्रोग्राम में शामिल होने वाले ग्राहकों के लिए उपलब्ध है, शामिल होने के लिए, कृपया हमसे संपर्क करें ea@catonetworks.com
बीटा
- वहाँ स्कीमा में परिवर्तन हो सकते हैं
- अल्प सूचना के लिए बदलाव, संभवतः केवल दो सप्ताह के
- बीटा APIs पूरी कार्यात्मकता का समर्थन करते हैं
रोलआउट
- ये GA API कुछ हफ्तों की अवधि में सभी खातों के लिए धीरे-धीरे जारी किए जा रहे हैं
- रोलआउट स्थिति में किसी API को कॉल करना एक त्रुटि संदेश दे सकता है क्योंकि वह API आपके खाते के लिए अभी उपलब्ध नहीं है

संभावित तोड़ने वाले स्कीमा परिवर्तन

यह अनुभाग उन समयों पर चर्चा करता है जब Cato API स्कीमा में ऐसे परिवर्तन करता है जो API कॉल के लिए व्यवहार और परिणामों को प्रभावित कर सकता है।

ग्राफ़क्यूएल में संभावित तोड़ने वाला परिवर्तन क्या है?

ग्राफ़क्यूएल में संभावित तोड़ने वाला परिवर्तन तब होता है जब API को अपडेट करने के लिए क्लाइंट अनुप्रयोगों को अपनी क्वेरी या लॉजिक को अद्यतन करने की आवश्यकता होती है ताकि कार्यक्षमता बनाए रखी जा सके। उदाहरण शामिल हैं:

किसी फ़ील्ड, प्रकार, या तर्क को हटाना।
फ़ील्ड्स, प्रकार, या तर्कों के नाम बदलना।
तर्कों के लिए डिफ़ॉल्ट मानों को संशोधित करना जिससे क्वेरी या म्यूटेशन के अपेक्षित परिणाम बदलते हैं।
किसी फ़ील्ड के प्रकार या व्यवहार में परिवर्तन करना जो संगतता को प्रभावित करता है। उदाहरण के लिए, किसी फ़ील्ड के प्रकार को बदलना (उदा., Int से String) या किसी तर्क की नलता में संशोधन करना (उदा., नल करने योग्य से नॉन-नल करना)।

संभावित तोड़ने वाले परिवर्तनों की घोषणा और प्रबंधन

हम यथासंभव कठिनाई से संभावित तोड़ने वाले परिवर्तन से बचने के लिए काम करते हैं। हालांकि, दुर्लभ मामले में, यदि ऐसा परिवर्तन होता है, तो इसे समझाया गया है कि यह EoL API की सूचना में ग्राहकों को सूचित किया जाएगा।

ये परिवर्तन बीटा API के लिए अधिक बार हो सकते हैं लेकिन GA API के लिए दुर्लभ होते हैं।

अप्रचलित API

अप्रचलित के रूप में चिह्नित एक API या फ़ील्ड इंगित करता है कि इसका उपयोग अब अनुशंसित नहीं है, और एक बेहतर विकल्प उपलब्ध है। हम अनुशंसा करते हैं कि आप स्क्रिप्ट और प्रक्रियाओं को अपडेट करें ताकि अप्रचलित API और फ़ील्ड्स का उपयोग न हो ताकि अपेक्षित व्यवहार और कार्यक्षमता बनाए रखी जा सके।

EoL API की सूचना

यदि कोई API या फ़ील्ड हटाए जाने या प्रतिस्थापन के लिए योजना में है, तो यह एक जीवन-अंत (EoL) प्रक्रिया से गुजरेगा। इस प्रक्रिया में निम्नलिखित चरण शामिल हैं:

API या फ़ील्ड को अप्रचलित के रूप में चिह्नित करना
1. हटाए जाने की योजना वाले API या फ़ील्ड को अप्रचलित में चिह्नित किया गया है Cato Networks GraphQL API संदर्भ में।
2. यह लेबल एक संदेश के साथ होता है, जो एक वैकल्पिक API या फ़ील्ड विशेष करता है यदि लागू हो, और योजना की गई EoL तिथि।
EoL सूचनाएं
1. Cato API संभावित तोड़ने वाले परिवर्तन और EoL लेख को अद्यतन किया जाता है कि किस विशिष्ट तिथि का स्कीमा परिवर्तन के साथ अद्यतन किया जाएगा।
2. सूचना और स्कीमा परिवर्तनों के बीच की समयावधि इस प्रकार है:
  - GA API: कम से कम 3 महीने पहले और आमतौर पर 6 महीने पहले
  - बीटा API: आमतौर पर 2 सप्ताह पहले
3. EoL सूचना और EoL तिथि के बीच की समय अवधि में, ग्राहकों को GraphQL स्कीमा में परिवर्तन के अनुकूल बनाने के लिए क्लाइंट कोड को अपडेट करने की अपेक्षा की जाती है।

गैर-तोड़ने वाले स्कीमा परिवर्तन

जिन ग्राफ़क्यूएल परिवर्तनों को गैर-तोड़ने वाला और फिर भी महत्वपूर्ण माना जाता है, जैसे नए API या नए फ़ील्ड्स, उन्हें Cato API Changelog लेख में घोषित किया जाता है।

Cato Networks GraphQL API संदर्भ हमेशा पूर्ण समर्थित अद्यतन ग्राफ़क्यूएल स्कीमा को शामिल करता है।