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

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

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

apigee-access पाना

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

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

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

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

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

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

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

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

Key Value 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 - Node.js ऐप्लिकेशन, Apigee Edge पर चल रहा है और इसमें सभी सुविधाएं काम करती हैं.
  • standalone - Node.js ऐप्लिकेशन, Apigee Edge एनवायरमेंट के बाहर चल रहा है. साथ ही, दस्तावेज़ में सबसे ऊपर बताई गई डिफ़ॉल्ट सुविधा लागू होती है.

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

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

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

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

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

वैरिएबल रीड-ओनली समस्या ध्यान दें
client.received.start.time हां स्ट्रिंग अनुरोध मिलने का समय
client.received.end.time हां स्ट्रिंग अनुरोध मिलने का समय
client.received.start.timestamp हां पूर्णांक अनुरोध मिलने का समय
client.received.end.timestamp हां पूर्णांक अनुरोध मिलने का समय

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