हमने हाल ही में इंटरसिस्टम्स एपीआई मैनेजर (आईएएम) जारी किया है, जो इंटरसिस्टम्स आईआरआईएस डेटा प्लेटफ़ॉर्म का एक नया घटक है जो आईटी बुनियादी ढांचे में वेब एपीआई ट्रैफ़िक की दृश्यता, नियंत्रण और प्रबंधन प्रदान करता है।

इस लेख में, मैं आपको दिखाऊंगा कि IAM कैसे स्थापित करें और IAM के साथ आपके लिए उपलब्ध कई क्षमताओं में से कुछ का प्रदर्शन करें। इंटरसिस्टम्स एपीआई प्रबंधक आपको इसकी अनुमति देता है:

एपीआई की निगरानी करें, समझें कि एपीआई का उपयोग कौन करता है, कौन से एपीआई सबसे लोकप्रिय हैं और किन में सुधार की आवश्यकता है।
नियंत्रित करें कि एपीआई का उपयोग कौन करता है और एपीआई उपयोग को सरल पहुंच प्रतिबंधों से अनुरोध-आधारित प्रतिबंधों तक सीमित करें - आपके पास कस्टम नियंत्रण है और आप बदलते एपीआई उपभोग पैटर्न पर तुरंत प्रतिक्रिया दे सकते हैं।
OAuth2.0, LDAP या कुंजी टोकन प्रमाणीकरण जैसे केंद्रीकृत सुरक्षा तंत्र का उपयोग करके सुरक्षित एपीआई।
तृतीय-पक्ष डेवलपर्स के लिए इसे आसान बनाएं और एक समर्पित डेवलपर पोर्टल खोलकर उन्हें बेहतर एपीआई अनुभव प्रदान करें।
एपीआई को स्केल करें और न्यूनतम प्रतिक्रिया विलंबता सुनिश्चित करें।

एपीआई प्रबंधन एसओए या माइक्रोसर्विस आर्किटेक्चर में संक्रमण के लिए आवश्यक है, व्यक्तिगत (सूक्ष्म) सेवाओं के बीच एकीकरण को सरल बनाना, उन्हें सभी बाहरी और आंतरिक उपभोक्ताओं के लिए उपलब्ध कराना। परिणामस्वरूप, नए एपीआई बनाना, बनाए रखना और उपभोग करना आसान हो जाता है।

यदि आप पहले से ही इंटरसिस्टम्स आईआरआईएस का उपयोग कर रहे हैं, तो आप अपने लाइसेंस में आईएएम विकल्प जोड़ सकते हैं। इंटरसिस्टम्स आईआरआईएस ग्राहकों के लिए आईएएम विकल्प निःशुल्क है, लेकिन आईएएम का उपयोग शुरू करने के लिए आपको इंटरसिस्टम्स से एक नई लाइसेंस कुंजी का अनुरोध करना होगा।

यदि आप अभी तक इंटरसिस्टम्स आईआरआईएस का उपयोग नहीं कर रहे हैं और इंटरसिस्टम्स एपीआई मैनेजर को आज़माने की योजना बना रहे हैं, तो कृपया इंटरसिस्टम्स से संपर्क करें।

आरंभ करना और स्थापना

इंटरसिस्टम्स ग्राहक वेबसाइट से आईएएम वितरण डाउनलोड कर सकते हैं WRC अनुभाग "सॉफ़्टवेयर वितरण" और डॉकर कंटेनर के रूप में चलाएं। न्यूनतम सिस्टम आवश्यकताएँ:

डाक में काम करनेवाला मज़दूर 17.04.0 +।
डॉकर लिखें 1.12.0 +।
इंटरसिस्टम्स आईआरआईएस 2019.1.1+।

प्रारंभ में, आपको डॉकर छवि डाउनलोड करने की आवश्यकता है (महत्वपूर्ण! WRC के साथ संग्रह एक डॉकर छवि नहीं है, आपको इसे अनपैक करने की आवश्यकता है, अंदर एक डॉकर छवि है):

docker load -i iam_image.tar

यह कमांड IAM छवि को आपके सर्वर पर बाद में उपयोग के लिए उपलब्ध कराएगा। IAM एक अलग कंटेनर के रूप में चलता है, इसलिए आप इसे InterSystems IRIS से स्वतंत्र रूप से स्केल कर सकते हैं। IAM चलाने के लिए लाइसेंस डाउनलोड करने के लिए इंटरसिस्टम्स IRIS तक पहुंच की आवश्यकता होती है।

इंटरसिस्टम्स आईआरआईएस सेट करें:

वेब एप्लिकेशन सक्षम करें /api/IAM
उपयोगकर्ता सक्षम करें IAM
उपयोगकर्ता पासवर्ड बदलें IAM

अब आइए IAM कंटेनर शुरू करें। संग्रह में आपको स्क्रिप्ट मिलेंगी iam-setup विंडोज़ और यूनिक्स (और मैक) के लिए। ये स्क्रिप्ट आपको पर्यावरण चर को सही ढंग से सेट करने में मदद करेंगी, जिससे IAM कंटेनर को इंटरसिस्टम्स IRIS के साथ कनेक्शन स्थापित करने की अनुमति मिलेगी। मैक पर चलने वाली स्क्रिप्ट का एक उदाहरण यहां दिया गया है:

source ./iam-setup.sh 
Welcome to the InterSystems IRIS and InterSystems API Manager (IAM) setup script.
This script sets the ISC_IRIS_URL environment variable that is used by the IAM container to get the IAM license key from InterSystems IRIS.
Enter the full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1
Enter the IP address for your InterSystems IRIS instance. The IP address has to be accessible from within the IAM container, therefore, do not use "localhost" or "127.0.0.1" if IRIS is running on your local machine. Instead use the public IP address of your local machine. If IRIS is running in a container, use the public IP address of the host environment, not the IP address of the IRIS container. xxx.xxx.xxx.xxx               
Enter the web server port for your InterSystems IRIS instance: 52773
Enter the password for the IAM user for your InterSystems IRIS instance: 
Re-enter your password: 
Your inputs are:
Full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1
IP address for your InterSystems IRIS instance: xxx.xxx.xxx.xxx
Web server port for your InterSystems IRIS instance: 52773
Would you like to continue with these inputs (y/n)? y
Getting IAM license using your inputs...
Successfully got IAM license!
The ISC_IRIS_URL environment variable was set to: http://IAM:****************@xxx.xxx.xxx.xxx:52773/api/iam/license
WARNING: The environment variable is set for this shell only!
To start the services, run the following command in the top level directory: docker-compose up -d
To stop the services, run the following command in the top level directory: docker-compose down
URL for the IAM Manager portal: http://localhost:8002

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

स्क्रिप्ट चलाने के बजाय, आप मैन्युअल रूप से पर्यावरण चर सेट कर सकते हैं:

ISC_IAM_IMAGE=intersystems/iam:0.34-1-1
ISC_IRIS_URL=http://IAM:<PASS>@<IP>:<PORT>/api/iam/license

Запуск

आइए अब कमांड चलाकर IAM लॉन्च करें:

docker-compose up -d

यह कमांड IAM कंटेनरों को व्यवस्थित करता है और सुनिश्चित करता है कि सब कुछ सही ढंग से चल रहा है। कमांड का उपयोग करके कंटेनरों की स्थिति की जाँच की जाती है:

docker ps

अपने ब्राउज़र में एडमिन इंटरफ़ेस खोलें localhost:8002.

यह अभी खाली है क्योंकि यह पूरी तरह से नया नोड है। आइए इसे बदलें. IAM एपीआई को मॉड्यूल और/या कमांड में विभाजित करने के लिए कार्यस्थानों की अवधारणा का समर्थन करता है। "डिफ़ॉल्ट" कार्यक्षेत्र पर जाएँ जिसका उपयोग हम अपने प्रयोगों के लिए करेंगे।

इस कार्यक्षेत्र के लिए अनुरोधों की संख्या अभी भी शून्य है, लेकिन आपको बाईं ओर मेनू में बुनियादी IAM अवधारणाओं का अंदाजा मिल जाएगा। पहले दो तत्व: सेवाएँ और मार्ग सबसे महत्वपूर्ण हैं:

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

सेवा

आइए निम्नलिखित मानों के साथ एक इंटरसिस्टम्स आईआरआईएस सेवा बनाएं:

क्षेत्र
मूल्य
विवरण

नाम
ईरिस
सेवा का नाम

मेजबान
IP
इंटरसिस्टम्स आईआरआईएस सर्वर होस्ट या आईपी

बंदरगाह
52773
इंटरसिस्टम्स आईआरआईएस सर्वर वेब पोर्ट

पथ
/एपीआई/एटेलियर
मूल पथ

प्रोटोकॉल
http
प्रोटोकॉल

शेष मानों को डिफ़ॉल्ट के रूप में छोड़ दें। बटन को क्लिक करे Create और बनाई गई सेवा की आईडी लिखें।

मार्ग

अब आइए एक मार्ग बनाएं:

क्षेत्र
मूल्य
विवरण

पथ
/एपीआई/एटेलियर
मूल पथ

प्रोटोकॉल
http
प्रोटोकॉल

service.id
3 से मार्गदर्शन
सेवा (पिछले चरण से आईडी)

शेष मानों को डिफ़ॉल्ट के रूप में छोड़ दें। बटन को क्लिक करे Create और बनाए गए रूट की आईडी लिखें। डिफ़ॉल्ट रूप से, IAM पोर्ट 8000 पर आने वाले अनुरोधों को सुनता है। अब अनुरोध भेजे गए हैं http://localhost:8000 और से शुरू हो रहा है /api/atelier इंटरसिस्टम्स आईआरआईएस पर पुनर्निर्देशित किया गया है।

परीक्षण

आइए एक REST क्लाइंट में एक अनुरोध बनाने का प्रयास करें (मैं इसका उपयोग कर रहा हूं पोस्टमैन).

आइए एक GET अनुरोध भेजें http://localhost:8000/api/atelier/ (भूलना नहीं / अंत में) और इंटरसिस्टम्स आईआरआईएस से प्रतिक्रिया प्राप्त करें। प्रत्येक अनुरोध IAM के माध्यम से जाता है जो मेट्रिक्स एकत्र करता है:

HTTP स्थिति कोड.
देरी।
निगरानी (यदि कॉन्फ़िगर किया गया हो)।

मैंने कुछ और अनुरोध किए (जिनमें /api/atelier/est/ जैसे गैर-मौजूद समापन बिंदुओं के लिए दो अनुरोध शामिल हैं), परिणाम तुरंत डैशबोर्ड में दिखाई देते हैं:

प्लगइन्स के साथ काम करना

अब जब हमारे पास रूट कॉन्फ़िगर हो गया है, तो हम अपना एपीआई प्रबंधित कर सकते हैं। हम ऐसी सुविधाएँ जोड़ सकते हैं जो हमारी सेवा की पूरक होंगी।

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

अनुरोधों की संख्या सीमित करना

बाएं साइडबार मेनू में प्लगइन्स पर क्लिक करें। आप इस स्क्रीन पर सभी सक्रिय प्लगइन्स देख सकते हैं, लेकिन चूंकि यह IAM सर्वर नया है, इसलिए अभी तक कोई सक्रिय प्लगइन्स नहीं हैं। तो “नया प्लगइन” पर क्लिक करके अगले चरण पर आगे बढ़ें।

हमें जिस प्लगइन की आवश्यकता है वह "ट्रैफ़िक कंट्रोल" श्रेणी में है और इसे "रेट लिमिटिंग" कहा जाता है। इसे चुनें. ऐसी कई सेटिंग्स हैं जिन्हें आप यहां सेट कर सकते हैं, लेकिन हम केवल दो क्षेत्रों की परवाह करते हैं:

क्षेत्र
मूल्य
विवरण

मार्ग_आईडी
ID
रूट आईडी

config.मिनट
5
प्रति मिनट अनुरोधों की संख्या

बस इतना ही। प्लगइन कॉन्फ़िगर और सक्रिय है. ध्यान दें कि हम अलग-अलग समय अंतराल चुन सकते हैं, जैसे एक मिनट, एक घंटा या एक दिन। सेटिंग्स को संयोजित किया जा सकता है (उदाहरण के लिए, प्रति घंटे 1000 अनुरोध और एक ही समय में प्रति मिनट 100 अनुरोध)। मैंने मिनट्स को चुना क्योंकि इससे प्लगइन की कार्यक्षमता की जांच करना आसान हो जाता है।

यदि आप पोस्टमैन में वही अनुरोध दोबारा भेजते हैं, तो आप देखेंगे कि प्रतिक्रिया 2 अतिरिक्त हेडर के साथ वापस आ गई है:

XRateLimit-सीमा-मिनट: 5
XRateLimit-शेष-मिनट: 4

यह क्लाइंट को बताता है कि वह प्रति मिनट 5 अनुरोध तक कर सकता है और वर्तमान समय स्लॉट में 4 और अनुरोध कर सकता है।

यदि आप एक ही अनुरोध बार-बार करते हैं, तो अंततः आपका उपलब्ध कोटा समाप्त हो जाएगा और इसके बदले आपको निम्नलिखित प्रतिक्रिया निकाय के साथ 429 का HTTP स्थिति कोड प्राप्त होगा:

एक मिनट रुकें और आप फिर से अनुरोध सबमिट कर सकेंगे।

यह एक सुविधाजनक तंत्र है जो आपको इसकी अनुमति देता है:

बैकएंड को लोड बढ़ने से बचाएं।
ग्राहकों को बताएं कि वे कितने अनुरोध कर सकते हैं।
एपीआई का मुद्रीकरण करें।

आप अलग-अलग समय अंतराल के लिए मान सेट कर सकते हैं और इस प्रकार एक निश्चित अवधि में एपीआई ट्रैफ़िक को सुचारू कर सकते हैं। मान लीजिए कि आप किसी विशेष रूट पर प्रति घंटे 600 अनुरोधों की अनुमति देते हैं। प्रति मिनट औसतन 10 अनुरोध आते हैं। लेकिन क्लाइंट को घंटे के पहले मिनट में सभी 600 अनुरोधों को पूरा करने से कोई नहीं रोकता है। शायद आपको यही चाहिए. हो सकता है कि आप एक घंटे के दौरान और भी अधिक भार प्राप्त करना चाहें। फ़ील्ड मान सेट करके config.minute 20 का मान यह सुनिश्चित करता है कि आपके उपयोगकर्ता प्रति मिनट 20 से अधिक अनुरोध और प्रति घंटे 600 अनुरोध न करें। यह प्रति मिनट 10 अनुरोधों के पूर्ण औसत प्रवाह की तुलना में एक मिनट के अंतराल पर छोटे स्पाइक्स की अनुमति देता है, लेकिन उपयोगकर्ता एक मिनट के लिए प्रति घंटा कोटा का उपयोग नहीं कर सकते हैं। अब उन्हें अपने सभी अनुरोधों का उपयोग करने के लिए कम से कम 30 मिनट की आवश्यकता होगी। ग्राहकों को प्रत्येक निर्दिष्ट समय अंतराल के लिए अतिरिक्त हेडर प्राप्त होंगे, उदाहरण के लिए:

HTTP शीर्षलेख
मूल्य

एक्स-रेटलिमिट-लिमिट-घंटा
600

एक्स-रेटलिमिट-शेष-घंटा
595

एक्स-रेटलिमिट-लिमिट-मिनट
20

एक्स-रेटलिमिट-शेष-मिनट
16

बेशक, आप जो हासिल करना चाहते हैं उसके आधार पर क्वेरी सीमाओं को कॉन्फ़िगर करने के कई अलग-अलग तरीके हैं।

निष्कर्ष

मैं यहीं समाप्त करूंगा, मुझे लगता है कि इंटरसिस्टम्स एपीआई मैनेजर के बारे में पहले लेख के लिए पर्याप्त सामग्री है। हमने 40 से अधिक प्लगइन्स में से केवल एक का उपयोग किया। IAM के साथ आप और भी कई दिलचस्प चीज़ें कर सकते हैं:

अपने सभी एपीआई के लिए एक केंद्रीय प्रमाणीकरण तंत्र जोड़ें।
एकाधिक सेवाओं में लोड बैलेंसर का उपयोग करके लोड को स्केल करें।
पूर्ण अद्यतन से पहले परीक्षण दर्शकों में नई कार्यक्षमता और बग समाधान जोड़ें।
आंतरिक और बाहरी डेवलपर्स को सभी एपीआई का दस्तावेजीकरण करने वाला एक समर्पित वेब पोर्टल प्रदान करें।
प्रतिक्रिया समय को कम करने और सिस्टम बैकएंड पर लोड को कम करने के लिए कैश अनुरोध।

संदर्भों

वेबिनार

हम आपको वेबिनार "एपीआई मैनेजमेंट विद इंटरसिस्टम्स एपीआई मैनेजमेंट" के लिए आमंत्रित करते हैं, जो 21 नवंबर को 10:00 मॉस्को समय (जीएमटी+3) पर होगा।
इंटरसिस्टम्स एपीआई मैनेजर (आईएएम) इंटरसिस्टम्स आईआरआईएस डेटा प्लेटफ़ॉर्म का एक नया घटक है जो आईटी बुनियादी ढांचे के भीतर वेब एपीआई से/से ट्रैफ़िक की निगरानी, नियंत्रण और प्रबंधन प्रदान करता है। वेबिनार में हम इंटरसिस्टम एपीआई प्रबंधन की प्रमुख क्षमताओं का प्रदर्शन करेंगे:

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

वेबिनार आर्किटेक्ट्स, डेवलपर्स और सिस्टम प्रशासकों के लिए है।

पंजीकरण आवश्यक है!

स्रोत: www.habr.com

इंटरसिस्टम एपीआई मैनेजर का परिचय (+ वेबिनार)

आरंभ करना और स्थापना

Запуск

सेवा

मार्ग

परीक्षण

प्लगइन्स के साथ काम करना

अनुरोधों की संख्या सीमित करना

निष्कर्ष

संदर्भों

वेबिनार

एक टिप्पणी जोड़ें उत्तर रद्द