Utilizzo del modulo di accesso Apigee

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Il modulo apigee-access ti consente di accedere alle variabili di flusso e alle cache del proxy API dal codice dell'applicazione Node.js. Il modulo è incluso nella piattaforma Apigee Edge; non è necessario installarlo come 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 in Edge, questo modulo è disponibile. Devi semplicemente richiederlo in qualsiasi codice Node.js di cui esegui il deployment. Ad esempio:

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

Accesso alle variabili di flusso

Quando esegui il deployment di un'applicazione Node.js su Edge, puoi accedere a qualsiasi variabile di flusso "pronta all'uso" supportata, variabile di flusso creata dai criteri e qualsiasi variabile di flusso creata autonomamente dall'interno del codice Node.js. Le variabili di flusso vengono create ed esistono nel contesto di un proxy API in esecuzione su Edge. Per informazioni dettagliate, consulta Accesso alle variabili di flusso in Node.js.

Accesso alla cache

Il modulo apigee-access ti consente di accedere alla cache distribuita di Apigee Edge dal tuo codice Node.js. Per informazioni dettagliate, vedi Accesso alla cache in Node.js.

Utilizzo del servizio per le quote

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

Accesso alle mappe chiave-valore

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

Esecuzione in modalità locale e modalità di cui è stato eseguito il deployment

Per supportare sviluppo e test locali, il modulo apigee-access funziona in modalità locale senza dipendenze su 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à nativa di Edge. Ad esempio, tutte le variabili di flusso sono accessibili in modalità di deployment, mentre solo un piccolo sottoinsieme è disponibile quando esegui l'applicazione Node.js localmente. Per un elenco di queste variabili in modalità locale, consulta la sezione Esecuzione in modalità locale.

Determinazione della modalità in cui è in esecuzione il modulo

Per determinare in quale modalità esegui apigee-access:

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

Il valore restituito da getMode() indica se il deployment dell'applicazione Node.js è stato eseguito 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 viene eseguita al di fuori dell'ambiente Apigee Edge e viene applicata la funzionalità predefinita descritta all'inizio del documento.

Esecuzione in modalità di deployment

Con il deployment su Edge, le variabili impostate dai criteri sono visibili a apigee-access, mentre le variabili aggiunte o modificate dai metodi di questo modulo sono visibili ai criteri successivi nel flusso del proxy.

Puoi trovare il link delle variabili supportate nella sezione Riferimento variabili. Queste variabili, così come 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 variabili.

Esecuzione in modalità locale

In "modalità locale" esegui il codice Node.js al di fuori del contesto di Apigee Edge. In questa modalità, la maggior parte delle variabili di flusso predefinite non è accessibile all'interno del codice Node.js. Questa tabella mostra un 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 Digitare Notes
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. Consulta la pagina di riferimento sulle variabili di Apigee Edge per l'elenco completo.