एक्सएमएल फ़ाइलों में नीतियों को अटैच और कॉन्फ़िगर करना

यहां Apigee Edge से जुड़े दस्तावेज़ देखे जा रहे हैं.
Apigee X
से जुड़े दस्तावेज़ पर जाएं.
info

अपनी पसंद के टेक्स्ट या एक्सएमएल-अवेयर एडिटर या IDE का इस्तेमाल करके, नीतियां स्थानीय तौर पर बनाई और उनमें बदलाव किया जा सकता है. इस विषय में, कोटा नीति के टाइप का इस्तेमाल, नीतियों को बनाने, कॉन्फ़िगर करने, अटैच करने, डिप्लॉय करने, और उनकी जांच करने के तरीके के उदाहरण के तौर पर किया गया है.

ज़्यादातर एपीआई प्रॉक्सी, कोटा लागू करती हैं. कोटा की मदद से, यह कंट्रोल किया जा सकता है कि क्लाइंट ऐप्लिकेशन को किसी तय समयावधि में, कितनी बार एपीआई को कॉल करने की अनुमति है. यहां दिए गए उदाहरण में, कोटा नीति को इस तरह कॉन्फ़िगर किया गया है कि ऐप्लिकेशन हर मिनट में सिर्फ़ एक अनुरोध भेज सकें. (हालांकि, यह व्यावहारिक नहीं है, लेकिन इससे नीति के असर को आसानी से समझा जा सकता है.)

एपीआई प्रॉक्सी कॉन्फ़िगरेशन में, नीति वाली फ़ाइलें /apiproxy/policies डायरेक्ट्री में एक्सएमएल फ़ाइलों के तौर पर सेव की जाती हैं.

उदाहरण के लिए, "QuotaPolicy" नाम की कोटा टाइप की नीति को QuotaPolicy.xml नाम की फ़ाइल के तौर पर बनाया जा सकता है. इसमें यह कॉन्टेंट शामिल हो सकता है:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

टेक्स्ट फ़ाइल को खुद बनाया जा सकता है. इसके अलावा, एक्सएमएल स्कीमा से नीति जनरेट की जा सकती है. सभी नीतियों में कुछ सेटिंग होती हैं. ये सेटिंग, नीति के टाइप के हिसाब से अलग-अलग होती हैं. वहीं, कुछ सेटिंग सभी नीतियों के लिए एक जैसी होती हैं.

मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में नीतियां अटैच करने पर, एपीआई प्रॉक्सी बिल्डर, चुने गए नीति के टाइप के लिए एक्सएमएल स्कीमा से नीति का इंस्टेंस जनरेट करता है. इसलिए, नीति के कॉन्फ़िगरेशन में आपको ऐसे एलिमेंट दिख सकते हैं जो साफ़ तौर पर समझने के लिए, दस्तावेज़ में शामिल नहीं किए जाते.

सभी नीतियां, इन एट्रिब्यूट के बारे में बताती हैं:

  • enabled: इससे पता चलता है कि नीति "चालू" है या "बंद". इस सेटिंग को बदलकर, नीतियों को रनटाइम में चालू/बंद किया जा सकता है. अगर किसी नीति के लिए enabled falseसेट है, तो वह नीति लागू नहीं होती.
  • continueOnError: इससे तय होता है कि नीति के काम न करने पर, पाइपलाइन को मैसेज प्रोसेस करना जारी रखना चाहिए या नहीं. कोटा नीतियों को लागू करते समय, गड़बड़ियों से आम तौर पर यह पता चलता है कि कोटा खत्म हो गया है. इसलिए, इस एट्रिब्यूट की वैल्यू 'false' पर सेट होनी चाहिए.
  • name: यह इस नीति का नाम है. यह नाम, नीति के इस इंस्टेंस के लिए यूनीक होता है. इसका इस्तेमाल, नीति को प्रोसेसिंग के चरण के तौर पर फ़्लो में अटैच करने के लिए किया जाता है.

ऊपर दिए गए उदाहरण में, Allow, Interval, और TimeUnit एलिमेंट, कोटा नीति के लिए खास हैं. इन एलिमेंट में ऐसी सेटिंग होती हैं जिन्हें एपीआई की ओर से, एपीआई सेवाएं लागू करती हैं. नीति के अन्य टाइप, अपनी सेटिंग तय करते हैं. इनके बारे में, नीति के रेफ़रंस में जाना जा सकता है.