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

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं.
जानकारी

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

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

एपीआई प्रॉक्सी कॉन्फ़िगरेशन में, नीति की फ़ाइलों को /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: यह तय करता है कि नीति के काम न करने पर पाइपलाइन को मैसेज प्रोसेस करना जारी रखना चाहिए या नहीं. कोटा से जुड़ी नीतियां लागू करते समय, गड़बड़ियों का मतलब है कि कोटा पार हो गया है. इसलिए, इस एट्रिब्यूट को 'गलत' पर सेट किया जाना चाहिए.
  • name: वह नाम जो इस नीति को दिया जाता है. यह नाम इस नीति के इंस्टेंस के लिए खास होता है. इसका इस्तेमाल, प्रोसेसिंग के दौरान, फ़्लो में नीति को जोड़ने के लिए किया जाता है.

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