Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Mit dem Modul apigee-access können Sie über den Node.js-Anwendungscode auf API-Proxy-Flussvariablen und Caches zugreifen. Das Modul ist in der Apigee Edge-Plattform enthalten. Sie müssen es nicht wie bei anderen Node.js-Modulen installieren.
Apigee-Zugriff erhalten
Das Modul apigee-access ist in die Apigee Edge-Plattform eingebunden. Dieses Modul steht Ihnen zur Verfügung, wenn Sie Node.js-Code in Edge bereitstellen. Sie müssen sie nur in jedem Node.js-Code, den Sie bereitstellen, erforderlich machen. Beispiel:
var access=require('apigee-access');
Auf Ablaufvariablen zugreifen
Wenn Sie eine Node.js-Anwendung in Edge bereitstellen, können Sie auf alle unterstützten „Standard“-Flussvariablen, von Richtlinien erstellten Flussvariablen und alle von Ihnen selbst erstellten Flussvariablen in Ihrem Node.js-Code zugreifen. Flussvariablen werden erstellt und existieren im Kontext eines API-Proxys, der auf Edge ausgeführt wird. Weitere Informationen finden Sie unter In Node.js auf Flussvariablen zugreifen.
Auf den Cache zugreifen
Mit dem Modul apigee-access können Sie über Ihren Node.js-Code auf den verteilten Apigee Edge-Cache zugreifen. Weitere Informationen finden Sie unter Cache in Node.js aufrufen.
Kontingentdienst verwenden
Mit dem Modul apigee-access können Sie über Ihren Node.js-Code auf den Apigee Edge-Kontingentdienst zugreifen. Ausführliche Informationen finden Sie unter Zugriff auf den Kontingentdienst in Node.js.
Auf Schlüsselwertkarten zugreifen
Mit dem Modul apigee-access können Sie über Ihren Node.js-Code auf Schlüsselwertkarten (KVMs) von Apigee Edge zugreifen. Ausführliche Informationen finden Sie unter In Node.js auf Schlüssel/Wert-Zuordnungen zugreifen.
Lokaler und bereitgestellter Modus im Vergleich
Zur Unterstützung der lokalen Entwicklung und des Testens funktioniert das Modul apigee-access in einem lokalen Modus ohne Abhängigkeiten von Apigee Edge. Wenn das Modul jedoch mit einem API-Proxy verwendet wird, der in Edge bereitgestellt wird, wird die „lokale“ Funktionalität durch native Edge-Funktionalität ersetzt. Beispielsweise ist im bereitgestellten Modus auf die gesamte Zusammenstellung von Flussvariablen zugegriffen, während bei der lokalen Ausführung der Node.js-Anwendung nur ein kleiner Teil zur Verfügung steht. Eine Liste dieser Variablen im lokalen Modus finden Sie unter Im lokalen Modus ausführen.
Modus ermitteln, in dem das Modul ausgeführt wird
So ermitteln Sie, in welchem Modus Sie Apigee-Zugriff ausführen:
var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());
Der Rückgabewert von getMode() gibt an, ob die Node.js-Anwendung in Apigee Edge bereitgestellt oder im eigenständigen Modus ausgeführt wird. Die Methode gibt eines der beiden folgenden Stringergebnisse zurück:
apigee: Die Node.js-Anwendung wird auf Apigee Edge ausgeführt und alle Funktionen werden unterstützt.standalone: Die Node.js-Anwendung wird außerhalb der Apigee Edge-Umgebung ausgeführt. Die am Anfang des Dokuments beschriebene Standardfunktionalität wird wirksam.
Im bereitgestellten Modus ausführen
Bei der Bereitstellung in Edge sind die durch Richtlinien festgelegten Variablen für apigee-access sichtbar. Variablen, die von den Methoden dieses Moduls hinzugefügt oder geändert wurden, sind für nachfolgende Richtlinien im Proxyablauf sichtbar.
Links zu unterstützten Variablen finden Sie unter Variablenreferenz. Diese und alle Variablen, die Sie mit eigenen Namen erstellen, sind für apigee-access sichtbar. Beachten Sie, dass einige Variablen schreibgeschützt sind. Sie sind im Variablenreferenz aufgeführt.
Lokaler Modus
Im lokalen Modus führen Sie Ihren Node.js-Code außerhalb des Kontexts von Apigee Edge aus. In diesem Modus sind die meisten vordefinierten Flussvariablen in Ihrem Node.js-Code nicht zugänglich. Diese Tabelle zeigt die kleine Teilmenge der verfügbaren Flussvariablen. Diese Variablen werden hier unterstützt, um die lokale Entwicklung und das Testen von Node.js-Anwendungen für Apigee Edge zu unterstützen.
| Variable | Schreibgeschützt | Typ | Notes |
client.received.start.time |
Ja | String | Zeitpunkt, zu dem die Anfrage eingegangen ist |
client.received.end.time |
Ja | String | Zeitpunkt, zu dem die Anfrage eingegangen ist |
client.received.start.timestamp |
Ja | Ganzzahl | Zeitpunkt, zu dem die Anfrage eingegangen ist |
client.received.end.timestamp |
Ja | Ganzzahl | Zeitpunkt, zu dem die Anfrage eingegangen ist |
Auch hier wird auf der Apigee Edge-Plattform ein viel größerer Satz vordefinierter Variablen unterstützt. Die vollständige Liste finden Sie in der Variablenreferenz von Apigee Edge.