Dostęp do map par klucz-wartość w Node.js

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Za pomocą modułu apigee-access możesz pobierać dane z mapy klucz-wartość (KVM) Edge z aplikacji Node.js. Ta metoda pobierania KVM jest alternatywą dla używania zasady operacji na mapach klucz-wartość do pobierania danych KVM w przepływie serwera proxy interfejsu API.

KVM zapewniają długoterminową trwałość dowolnych par klucz-wartość, które można pobrać w czasie działania. Możesz na przykład przechowywać wartości limitów, wartości wygaśnięcia tokenów dostępu OAuth i wartości wygaśnięcia tokenów odświeżania OAuth w KVM dla każdego środowiska wdrożenia, a następnie pobierać te wartości w kodzie.

KVM możesz utworzyć w jednym z 3 zakresów: organization, environment, i apiproxy. Jeśli na przykład utworzysz KVM w zakresie apiproxy dla serwera proxy „foo”, tylko serwer proxy „foo” będzie mógł uzyskać dostęp do KVM. Jeśli utworzysz KVM w zakresie środowiska „test”, wszystkie serwery proxy interfejsu API wdrożone w środowisku „test” organizacji będą mogły uzyskać dostęp do KVM, ale żaden z serwerów proxy wdrożonych w środowisku „prod” nie będzie mógł uzyskać do niego dostępu.

Po utworzeniu KVM za pomocą interfejsu Management API, interfejsu zarządzania lub zasady operacji na mapach klucz-wartość (patrz Buforowanie długoterminowe ) użyj tych funkcji, aby pobrać dane.

Aby poznać świetny wzorzec KVM, zobacz Wzorzec buforowania wartości KVM.

Więcej informacji o module apigee-access i jego innych funkcjach znajdziesz w artykule Korzystanie z modułu apigee-access.

Metody

Te metody działają zarówno w przypadku zaszyfrowanych, jak i niezaszyfrowanych KVM.

• getKeyValueMap()
• getKeys()
• get()

getKeyValueMap

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

Pobiera KVM w określonym zakresie (organizacja, środowisko, interfejs API lub wersja). Po zwróceniu obiektu KVM użyj funkcji getKeys i get, aby zwrócić nazwy kluczy lub konkretną wartość klucza.

Parametry:

• kvm_name – nazwa KVM, do której chcesz uzyskać dostęp.
• scope – zakres KVM. Jedna z tych wartości: organization, environment, api, lub revision.
• proxy_name – tylko w przypadku scope of api only nazwa serwera proxy interfejsu API.

Zwroty:

Obiekt KVM.

Przykład:

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

Jeśli ustawisz scope na api, wymagany jest trzeci parametr – nazwa serwera proxy interfejsu API. Na przykład:

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

getKeys

Zwraca tablicę zawierającą nazwy wszystkich kluczy w KVM.

Parametry:

• callback: (wymagany) funkcja wywołania zwrotnego używa 2 parametrów:
  • obiekt Error, jeśli operacja się nie powiedzie;
  • obiekt (keys_array w powyższym przykładzie) reprezentujący tablicę nazw kluczy KVM.

Zwroty:

Tablica nazw kluczy KVM.

Przykład:

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

Pobiera wartość klucza KVM.

Parametry:

• key: (wymagany) ciąg znaków, który jednoznacznie identyfikuje element w pamięci podręcznej.

• callback: (wymagany) funkcja wywołania zwrotnego używa 2 parametrów:

  • obiekt Error, jeśli operacja się nie powiedzie;
  • obiekt zawierający wartość klucza KVM jako ciąg znaków.

Przykład:

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);
});