apigee-access मॉड्यूल का इस्तेमाल करना

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

apigee-access मॉड्यूल की मदद से, एपीआई प्रॉक्सी फ़्लो वैरिएबल और कैश मेमोरी को Node.js ऐप्लिकेशन कोड से ऐक्सेस किया जा सकता है. यह मॉड्यूल Apigee Edge प्लैटफ़ॉर्म के साथ शामिल है. आपको इसे इंस्टॉल करने की ज़रूरत नहीं है, जैसा कि दूसरे Node.js मॉड्यूल के लिए किया जाता है.

एपीआई ऐक्सेस पाने के लिए

apigee-access मॉड्यूल को Apigee Edge प्लैटफ़ॉर्म में इंटिग्रेट किया गया है. जब आप Edge पर Node.js कोड को डिप्लॉय करते हैं, तो यह मॉड्यूल आपके लिए उपलब्ध हो जाता है. आपको बस इसे डिप्लॉय किए जाने वाले किसी भी Node.js कोड में इस्तेमाल करना होगा. उदाहरण के लिए:

var access=require('apigee-access');

फ़्लो वैरिएबल को ऐक्सेस करना

जब किसी Node.js ऐप्लिकेशन को Edge पर डिप्लॉय किया जाता है, तो आपके पास काम करने वाले किसी भी "आउट-ऑफ़-द-बॉक्स" फ़्लो वैरिएबल, नीतियों के हिसाब से बनाए गए फ़्लो वैरिएबल, और अपने Node.js कोड से बनाए गए किसी भी फ़्लो वैरिएबल को ऐक्सेस करने का विकल्प होता है. फ़्लो वैरिएबल, Edge पर चल रहे एपीआई प्रॉक्सी के हिसाब से बनाए जाते हैं और मौजूद होते हैं. ज़्यादा जानकारी के लिए, Node.js में फ़्लो वैरिएबल ऐक्सेस करना देखें.

कैश मेमोरी को ऐक्सेस करना

apigee-access मॉड्यूल की मदद से, Apigee Edge से डिस्ट्रिब्यूट की गई कैश मेमोरी को अपने Node.js कोड से ऐक्सेस किया जा सकता है. ज़्यादा जानकारी के लिए, Node.js में कैश मेमोरी को ऐक्सेस करना लेख पढ़ें.

कोटा सेवा का इस्तेमाल करना

apigee-access मॉड्यूल की मदद से, Apigee Edge कोटा सेवा को अपने Node.js कोड से ऐक्सेस किया जा सकता है. ज़्यादा जानकारी के लिए, Node.js में कोटा सेवा ऐक्सेस करना देखें.

Maps की मुख्य वैल्यू ऐक्सेस करना

apigee-access मॉड्यूल की मदद से, अपने Node.js कोड से Apigee Edge के कुंजी मान मैप (केवीएम) को ऐक्सेस किया जा सकता है. ज़्यादा जानकारी के लिए, Node.js में मुख्य वैल्यू मैप ऐक्सेस करना देखें.

लोकल मोड बनाम डिप्लॉय मोड में चल रहा है

लोकल डेवलपमेंट और टेस्टिंग के लिए, apigee-access मॉड्यूल लोकल मोड में काम करता है. इसमें Apigee Edge पर कोई डिपेंडेंसी नहीं होती है. हालांकि, जब इस मॉड्यूल का इस्तेमाल ऐसे एपीआई प्रॉक्सी के साथ किया जाता है जिसे Edge पर डिप्लॉय किया जाता है, तो "लोकल" फ़ंक्शन को नेटिव Edge की सुविधा से बदल दिया जाता है. उदाहरण के लिए, फ़्लो वैरिएबल के सभी कॉम्प्लिमेंट को डिप्लॉय किए गए मोड में ऐक्सेस किया जा सकता है. हालांकि, Node.js ऐप्लिकेशन को स्थानीय तौर पर चलाने पर, सिर्फ़ एक छोटा सबसेट उपलब्ध होता है. इन लोकल-मोड वैरिएबल की सूची देखने के लिए, लोकल मोड में चल रहा है देखें.

उस मोड का पता लगाना जिसमें मॉड्यूल चल रहा है

यह पता लगाने के लिए कि किस मोड में apigee-access चलाया जा रहा है:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

getMode() की रिटर्न वैल्यू से आपको पता चलता है कि Node.js ऐप्लिकेशन को Apigee Edge पर डिप्लॉय किया गया है या नहीं. इसके अलावा, यह भी पता चलता है कि यह ऐप्लिकेशन स्टैंडअलोन मोड में चल रहा है या नहीं. यह तरीका, इन दोनों स्ट्रिंग नतीजों में से कोई एक दिखाता है:

• apigee - Apigee Edge पर Node.js ऐप्लिकेशन चल रहा है और सभी फ़ंक्शन इस पर काम करते हैं.
• standalone - Node.js ऐप्लिकेशन, Apigee Edge के बाहर चल रहा है. साथ ही, दस्तावेज़ में सबसे ऊपर बताया गया डिफ़ॉल्ट फ़ंक्शन लागू होता है.

डिप्लॉयमेंट मोड में चल रही है

Edge में डिप्लॉय किए जाने पर, नीतियों के ज़रिए सेट किए गए वैरिएबल apigee-access को दिखते हैं. साथ ही, इस मॉड्यूल के तरीकों से जोड़े या बदले गए वैरिएबल, प्रॉक्सी फ़्लो में बाद की नीतियों में दिखते हैं.

वैरिएबल रेफ़रंस में इस्तेमाल किए जा सकने वाले वैरिएबल का लिंक देखा जा सकता है. ये वैरिएबल और अपने नाम से बनाए गए वैरिएबल, apigee-access को दिखते हैं. ध्यान दें कि कुछ वैरिएबल रीड-ओनली होते हैं. इनकी पहचान वैरिएबल रेफ़रंस में की जाती है.

लोकल मोड में चल रही है

"लोकल मोड" में, Apigee Edge के बाहर अपना Node.js कोड चलाना. इस मोड में, पहले से तय किए गए ज़्यादातर फ़्लो वैरिएबल को आपके Node.js कोड से ऐक्सेस नहीं किया जा सकता. यह टेबल उपलब्ध फ़्लो वैरिएबल का एक छोटा सबसेट दिखाती है. ये वैरिएबल यहां काम करते हैं, ताकि Apigee Edge के लिए Node.js ऐप्लिकेशन को लोकल डेवलपमेंट और टेस्ट करने में मदद मिल सके.

वैरिएबल	रीड-ओनली	स्ट्रीम किस तरह की है	ज़रूरी जानकारी
client.received.start.time	हां	String	अनुरोध मिलने का समय
client.received.end.time	हां	String	अनुरोध मिलने का समय
client.received.start.timestamp	हां	Integer	अनुरोध मिलने का समय
client.received.end.timestamp	हां	Integer	अनुरोध मिलने का समय

फिर से, Apigee Edge प्लैटफ़ॉर्म पर, पहले से तय किए गए वैरिएबल का काफ़ी बड़ा सेट काम करता है. पूरी सूची के लिए, Apigee Edge वैरिएबल का रेफ़रंस देखें.