Accéder aux mappages clé-valeur dans Node.js

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Vous pouvez utiliser le module apigee-access pour obtenir des données de mappage clé-valeur (KVM) Edge à partir d'une application Node.js. Cette méthode de récupération de KVM est une alternative à l'utilisation de la règle des opérations de mappage clé-valeur pour récupérer les données KVM dans un flux de proxy d'API.

Les KVM permettent la persistance à long terme de paires clé/valeur arbitraires que vous pouvez récupérer au moment de l'exécution. Par exemple, vous pouvez stocker des valeurs de quota, des valeurs d'expiration de jeton d'accès OAuth et des valeurs d'expiration de jeton d'actualisation OAuth dans un KVM pour chaque environnement de déploiement, puis récupérer les valeurs dans votre code.

Vous pouvez créer un KVM à l'un des trois niveaux suivants : organization, environment et apiproxy. Par exemple, si vous créez un KVM au niveau du proxy d'API "foo", seul le proxy "foo" peut y accéder. Si vous créez un KVM au niveau de l'environnement de test, tous les proxys d'API déployés dans l'environnement de test d'une organisation peuvent y accéder, mais aucun des proxys déployés dans l'environnement de production ne peut y accéder.

Après avoir créé un KVM avec l'API de gestion, l'interface utilisateur de gestion ou la règle Key Value Map Operations (voir Mise en cache de la persistance à long terme), utilisez les fonctions ci-dessous pour récupérer les données.

Pour obtenir un excellent modèle KVM, consultez Modèle de mise en cache des valeurs KVM.

Pour obtenir une présentation du module apigee-access et de ses autres fonctionnalités, consultez Utiliser le module apigee-access.

Méthodes

Les méthodes suivantes fonctionnent sur les KVM chiffrés et non chiffrés.

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

getKeyValueMap

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

Récupère un KVM dans un champ d'application spécifique (organisation, environnement, API ou révision). Une fois l'objet KVM renvoyé, utilisez les fonctions getKeys et get pour renvoyer les noms de clés ou une valeur de clé spécifique.

Paramètres :

• kvm_name : nom du KVM auquel accéder.
• scope : champ d'application du KVM. Spécifiez l'une des valeurs suivantes : organization, environment, api, ou revision.
• proxy_name : nom du proxy d'API pour un scope de api uniquement.

Renvoie :

Un objet KVM.

Exemple :

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

Si vous définissez scope sur api, un troisième paramètre est requis : le nom du proxy d'API. Exemple :

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

getKeys

Renvoie un tableau contenant les noms de toutes les clés du KVM.

Paramètres :

• callback : (Obligatoire) La fonction de rappel utilise deux paramètres :
  • Objet Error si l'opération échoue.
  • Objet (keys_array dans l'exemple ci-dessus) qui représente le tableau des noms de clés KVM.

Renvoie :

Tableau de noms de clés KVM.

Exemple :

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

Récupère la valeur d'une clé KVM.

Paramètres :

• key : (obligatoire) chaîne qui identifie de manière unique l'élément dans le cache.

• callback : (obligatoire) La fonction de rappel utilise deux paramètres :

  • Objet Error si l'opération échoue.
  • Objet contenant la valeur de la clé KVM sous forme de chaîne.

Exemple :

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