Node.js में मुख्य वैल्यू वाले मैप ऐक्सेस करना

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

Node.js ऐप्लिकेशन में, Edge Key Value Map (KVM) का डेटा पाने के लिए, apigee-access मॉड्यूल का इस्तेमाल किया जा सकता है. एपीआई प्रॉक्सी फ़्लो में KVM डेटा पाने के लिए, Key Value Map Operations policy का इस्तेमाल करने के बजाय, KVM डेटा पाने का यह तरीका इस्तेमाल किया जा सकता है.

KVM, आर्बिट्ररी की/वैल्यू पेयर को लंबे समय तक बनाए रखते हैं. इन्हें रनटाइम पर वापस पाया जा सकता है . उदाहरण के लिए, हर डिप्लॉयमेंट एनवायरमेंट के लिए, KVM में कोटा वैल्यू, OAuth ऐक्सेस टोकन की समयसीमा खत्म होने की वैल्यू, और OAuth रीफ़्रेश टोकन की समयसीमा खत्म होने की वैल्यू स्टोर की जा सकती हैं. इसके बाद, अपने कोड में इन वैल्यू को वापस पाया जा सकता है.

KVM को इन तीन स्कोप में से किसी एक पर बनाया जा सकता है: organization, environment, और apiproxy. उदाहरण के लिए, अगर "foo" प्रॉक्सी के लिए, apiproxy स्कोप पर KVM बनाया जाता है, तो सिर्फ़ "foo" प्रॉक्सी ही KVM को ऐक्सेस कर सकती है. वहीं, अगर "test" एनवायरमेंट स्कोप पर KVM बनाया जाता है, तो किसी संगठन के "test" एनवायरमेंट में डिप्लॉय की गई सभी एपीआई प्रॉक्सी, KVM को ऐक्सेस कर सकती हैं. हालांकि, "prod" एनवायरमेंट में डिप्लॉय की गई कोई भी प्रॉक्सी, इसे ऐक्सेस नहीं कर सकती.

मैनेजमेंट एपीआई, मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) या Key Value Map Operations नीति (लंबे समय तक डेटा बनाए रखने के लिए कैश मेमोरी का इस्तेमाल करना देखें) की मदद से KVM बनाने के बाद, डेटा पाने के लिए यहां दिए गए फ़ंक्शन का इस्तेमाल करें.

KVM के पैटर्न के बारे में जानने के लिए, KVM वैल्यू को कैश मेमोरी में सेव करने का पैटर्न देखें.

apigee-access मॉड्यूल और उसकी अन्य सुविधाओं के बारे में जानने के लिए, Using the apigee-access module लेख पढ़ें.

तरीके

यहां दिए गए तरीके, एन्क्रिप्ट किए गए और एन्क्रिप्ट नहीं किए गए, दोनों तरह के KVM पर काम करते हैं.


getKeyValueMap

var kvm = apigee.getKeyValueMap('kvm_name', 'scope');
var kvm = apigee.getKeyValueMap('kvm_name', 'api', 'proxy_name');

यह फ़ंक्शन, किसी खास स्कोप (संगठन, एनवायरमेंट, एपीआई या वर्शन) पर KVM को वापस लाता है. KVM ऑब्जेक्ट वापस मिलने के बाद, कुंजी के नाम या किसी खास कुंजी की वैल्यू पाने के लिए, getKeys और get फ़ंक्शन का इस्तेमाल करें.

पैरामीटर:

  • kvm_name - यह उस KVM का नाम है जिसे ऐक्सेस करना है.
  • scope - यह KVM का स्कोप है. यह organization, environment, api, या revision में से कोई एक हो सकता है.
  • proxy_name - यह सिर्फ़ scope के api के लिए, एपीआई प्रॉक्सी का नाम है.

लौटाए गए सामान की कुल कीमत

एक KVM ऑब्जेक्ट.

उदाहरण:

var apigee = require('apigee-access');
var kvm = apigee.getKeyValueMap('my_kvm', 'environment');

अगर scope को api पर सेट किया जाता है, तो तीसरे पैरामीटर की ज़रूरत होती है - यह एपीआई प्रॉक्सी का नाम होता है. उदाहरण के लिए:

var kvm = apigee.getKeyValueMap('my_kvm', 'api', 'myApiProxy');

getKeys

var kvmKeys = apigee.getKeys(function(err, keys_array);

यह फ़ंक्शन, KVM में मौजूद सभी कुंजियों के नाम वाला एक ऐरे लौटाता है.

पैरामीटर:

  • callback: (ज़रूरी) कॉलबैक फ़ंक्शन, दो पैरामीटर का इस्तेमाल करता है:
    • अगर कार्रवाई पूरी नहीं होती है, तो एक Error ऑब्जेक्ट.
    • एक ऑब्जेक्ट (keys_array ऊपर दिए गए उदाहरण में), जो KVM कुंजी के नामों के ऐरे को दिखाता है.

लौटाए गए सामान की कुल कीमत

KVM कुंजी के नामों का एक ऐरे.

उदाहरण:

var apigee = require('apigee-access');
var kvm = apigee.getKeyValueMap('my_kvm', 'environment');
  kvm.getKeys(function(err, keys_array) {
    // use the array of key names here
});

get

kvm.get('key', function(err, key_value));

यह फ़ंक्शन, KVM कुंजी की वैल्यू पाता है.

पैरामीटर:

  • key: (ज़रूरी) यह एक स्ट्रिंग है, जो कैश मेमोरी में मौजूद आइटम की खास तौर पर पहचान करती है.

  • callback: (ज़रूरी) कॉलबैक फ़ंक्शन, दो पैरामीटर का इस्तेमाल करता है:

    • अगर कार्रवाई पूरी नहीं होती है, तो एक Error ऑब्जेक्ट.
    • वह ऑब्जेक्ट जिसमें KVM कुंजी की वैल्यू, स्ट्रिंग के तौर पर होती है.

उदाहरण:

var apigee = require('apigee-access');
var kvm = apigee.getKeyValueMap('my_kvm', 'environment');
  kvm.get('foo_key', function(err, key_value) {
    // Use the key value here. For example the following assigns the value
    // to a 'kvmvalue' variable in the response, which can be used by policies:
      apigee.setVariable(response, 'kvmvalue', key_value);
});