Utilizzo del modulo di accesso Apigee

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X.
info

Il modulo apigee-access consente di accedere alle variabili di flusso e alle cache dei proxy API da codice dell'applicazione Node.js. Il modulo è incluso nella piattaforma Apigee Edge; non è necessario installarlo come faresti con altri moduli Node.js.

Ottenere apigee-access

Il modulo apigee-access è integrato nella piattaforma Apigee Edge. Quando esegui il deployment del codice Node.js su Edge, questo modulo è a tua disposizione. Devi semplicemente richiederlo in qualsiasi codice Node.js di cui esegui il deployment. Ad esempio:

var access=require('apigee-access');

Accedere alle variabili di flusso

Quando esegui il deployment di un'applicazione Node.js su Edge, puoi accedere a una qualsiasi delle variabili di flusso "predefinite" supportate, alle variabili di flusso create dai criteri e a qualsiasi variabile di flusso che crei tu stesso dal codice Node.js. Le variabili di flusso vengono create ed esistono all'interno del contesto di un proxy API in esecuzione su Edge. Per informazioni dettagliate, consulta Accedere alle variabili di flusso in Node.js.

Accedere alla cache

Il modulo apigee-access consente di accedere alla cache distribuita di Apigee Edge da codice Node.js. Per informazioni dettagliate, consulta Accedere alla cache in Node.js.

Utilizzare il servizio di quota

Il modulo apigee-access consente di accedere al servizio di quota di Apigee Edge dal codice Node.js. Per informazioni dettagliate, consulta Accedere al servizio di quota in Node.js.

Accedere alle mappe chiave-valore

Il modulo apigee-access consente di accedere alle mappe chiave-valore (KVM) di Apigee Edge da codice Node.js. Per informazioni dettagliate, consulta Accedere alle mappe chiave-valore in Node.js.

Eseguire in modalità locale o di deployment

Per supportare lo sviluppo e i test locali, il modulo apigee-access funziona in modalità locale senza dipendenze da Apigee Edge; tuttavia, quando il modulo viene utilizzato con un proxy API di cui è stato eseguito il deployment su Edge, la funzionalità "locale" viene sostituita dalla funzionalità Edge nativa. Ad esempio, l' intero complemento delle variabili di flusso è accessibile in modalità di deployment, mentre solo un piccolo sottoinsieme è disponibile quando esegui l'applicazione Node.js in locale. Per un elenco di queste variabili in modalità locale, consulta Eseguire in modalità locale.

Determinare la modalità di esecuzione del modulo

Per determinare la modalità di esecuzione di apigee-access:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

Il valore restituito di getMode() indica se l'applicazione Node.js è di cui è stato eseguito il deployment su Apigee Edge o se è in esecuzione in modalità autonoma. Il metodo restituisce uno di questi due risultati di stringa:

  • apigee - L'applicazione Node.js è in esecuzione su Apigee Edge e tutte le funzionalità sono supportate.
  • standalone - L'applicazione Node.js è in esecuzione al di fuori dell'ambiente Apigee Edge e viene applicata la funzionalità predefinita descritta nella parte superiore del documento.

Eseguire in modalità di deployment

Quando viene eseguito il deployment su Edge, le variabili impostate dai criteri sono visibili a apigee-access, e le variabili aggiunte o modificate dai metodi di questo modulo sono visibili ai criteri successivi in the proxy flow.

Puoi trovare il link delle variabili supportate nel riferimento alle variabili. Queste variabili, e quelle che crei con i tuoi nomi, sono visibili a apigee-access. Tieni presente che alcune variabili sono di sola lettura. Sono identificate nel riferimento alle variabili.

Eseguire in modalità locale

In "modalità locale", il codice Node.js viene eseguito al di fuori del contesto di Apigee Edge. In questa modalità, la maggior parte delle variabili di flusso predefinite non è accessibile nel codice Node.js Questa tabella mostra il piccolo sottoinsieme di variabili di flusso disponibili. Queste variabili sono supportate qui per supportare lo sviluppo e i test locali delle applicazioni Node.js per Apigee Edge.

Variabile Sola lettura Tipo Note
client.received.start.time Stringa Ora in cui è stata ricevuta la richiesta
client.received.end.time Stringa Ora in cui è stata ricevuta la richiesta
client.received.start.timestamp Numero intero Ora in cui è stata ricevuta la richiesta
client.received.end.timestamp Numero intero Ora in cui è stata ricevuta la richiesta

Anche in questo caso, sulla piattaforma Apigee Edge è supportato un insieme molto più ampio di variabili predefinite. Per l'elenco completo, consulta il riferimento alle variabili di Apigee Edge Variabili Riferimento.