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

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Moduł apigee-access umożliwia pobieranie danych z mapy wartości klucza Edge (KVM) w aplikacji Node.js. Ta metoda pobierania mapy wartości klucza jest alternatywą dla używania zasady operacji na mapie wartości klucza do pobierania danych z mapy wartości klucza w przepływie proxy interfejsu API.

Mapy klucz-wartość zapewniają długoterminowe przechowywanie dowolnych par klucz-wartość, które można pobrać w czasie działania. Możesz na przykład przechowywać w KVM 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 dla każdego środowiska wdrażania, 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 mapę klucz-wartość w zakresie apiproxy dla serwera proxy „foo”, tylko ten serwer proxy będzie miał do niej dostęp. Jeśli utworzysz mapę klucz-wartość w zakresie środowiska „test”, wszystkie serwery proxy API wdrożone w środowisku „test” organizacji będą miały do niej dostęp, ale żaden z serwerów proxy wdrożonych w środowisku „prod” nie będzie miał do niej dostępu.

Po utworzeniu mapy wartości klucza za pomocą interfejsu API do zarządzania, interfejsu zarządzania lub zasady Operacje na mapie wartości klucza (patrz Długoterminowe buforowanie trwałe) użyj funkcji opisanych poniżej, aby pobrać dane.

Dobry wzorzec KVM znajdziesz w artykule Wzorzec buforowania wartości KVM.

Wprowadzenie do modułu apigee-access i jego innych funkcji znajdziesz w artykule Korzystanie z modułu apigee-access.

Metody

Poniższe metody działają zarówno w przypadku zaszyfrowanych, jak i niezaszyfrowanych maszyn KVM.

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

getKeyValueMap

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

Pobiera mapę wartości klucza 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órego chcesz uzyskać dostęp.
• scope – zakres KVM. Jeden z tych atrybutów: organization, environment, api, lub revision.
• proxy_name – w przypadku zakresu api 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 parametr 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 przykładzie powyżej) 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
});

uzyskać

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