Menggunakan modul akses apigee

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X.
info

Modul apigee-access memungkinkan Anda mengakses variabel alur proxy API dan cache dari dalam kode aplikasi Node.js. Modul ini disertakan dalam platform Apigee Edge; kamu tidak menginstalnya seperti yang Anda lakukan dengan modul Node.js lainnya.

Mendapatkan akses apigee

Modul apigee-access terintegrasi ke dalam platform Apigee Edge. Jika Anda men-deploy kode Node.js ke Edge, modul ini tersedia untuk Anda. Anda hanya perlu mewajibkannya di setiap kode Node.js yang Anda deploy. Contoh:

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

Mengakses variabel alur

Saat men-deploy aplikasi Node.js ke Edge, Anda dapat mengakses "out-of-the-box" variabel alur, variabel alur yang dibuat oleh kebijakan, dan variabel alur yang buat sendiri dari dalam kode Node.js. Variabel flow dibuat dan ada di dalam konteks proxy API yang berjalan di Edge. Untuk informasi mendetail, lihat Mengakses variabel alur di Node.js.

Mengakses cache

Modul apigee-access memungkinkan Anda mengakses cache terdistribusi Apigee Edge dari kode Node.js Anda. Untuk informasi selengkapnya, lihat Mengakses cache di Node.js.

Menggunakan layanan kuota

Modul apigee-access memungkinkan Anda mengakses layanan kuota Apigee Edge dari kode Node.js. Untuk informasi mendetail, lihat Mengakses layanan kuota di Node.js.

Mengakses Peta Nilai Kunci

Modul apigee-access memungkinkan Anda mengakses peta nilai kunci (KVM) Apigee Edge dari kode Node.js Anda. Untuk informasi mendetail, lihat Mengakses peta nilai kunci di Node.js.

Berjalan dalam mode lokal vs mode di-deploy

Untuk mendukung pengembangan dan pengujian lokal, modul apigee-access berfungsi dalam mode lokal tanpa dependensi di Apigee Edge; namun, saat modul digunakan dengan proxy API yang di-deploy ke Edge, "lokal" fungsi tersebut digantikan oleh fungsi Edge native. Misalnya, variabel alur yang sepenuhnya dapat diakses dalam mode yang di-deploy, sementara hanya sebagian kecil yang tersedia saat Anda menjalankan aplikasi Node.js secara lokal. Untuk daftar variabel mode lokal ini, lihat Berjalan dalam mode lokal.

Menentukan mode tempat modul dijalankan

Untuk menentukan mode mana yang Anda gunakan untuk menjalankan apigee-access:

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

Nilai hasil getMode() menunjukkan apakah aplikasi Node.js di-deploy atau tidak ke Apigee Edge atau berjalan dalam mode mandiri. Metode ini menampilkan salah satu dari dua string ini hasil:

  • apigee - Aplikasi Node.js berjalan di Apigee Edge dan di semua platform fungsionalitasnya didukung.
  • standalone - Aplikasi Node.js berjalan di luar Apigee Edge dan fungsionalitas {i>default<i} yang dijelaskan di bagian atas dokumen mengambil pengaruh tersebut.

Berjalan dalam mode di-deploy

Saat di-deploy ke Edge, variabel yang ditetapkan oleh kebijakan akan terlihat oleh apigee-access, dan variabel yang ditambahkan atau diubah oleh metode modul ini terlihat oleh kebijakan berikutnya di dalam alur proxy.

Anda dapat menemukan link variabel yang didukung di Referensi Variabel. Variabel-variabel ini dan apa pun yang Anda buat dengan nama Anda sendiri, dapat dilihat oleh apigee-access. Catatan bahwa beberapa variabel bersifat hanya baca. Mereka diidentifikasi dalam Referensi Variabel.

Berjalan dalam mode lokal

Dalam "mode lokal", Anda menjalankan kode Node.js di luar konteks Apigee Edge. Di beberapa pada mode ini, sebagian besar variabel alur yang telah ditetapkan tidak dapat diakses dalam Node.js Anda pada kode sumber. Tabel ini menunjukkan subset kecil variabel alur yang tersedia. Variabel-variabel ini didukung di sini untuk mendukung pengembangan dan pengujian lokal aplikasi Node.js untuk Apigee Edge.

Variabel Hanya-Baca Jenis Catatan
client.received.start.time Ya String Waktu saat permintaan diterima
client.received.end.time Ya String Waktu saat permintaan diterima
client.received.start.timestamp Ya Bilangan Bulat Waktu saat permintaan diterima
client.received.end.timestamp Ya Bilangan Bulat Waktu saat permintaan diterima

Sekali lagi, pada platform Apigee Edge, didukung kumpulan variabel bawaan yang jauh lebih besar. Lihat Variabel Apigee Edge Referensi untuk mengetahui daftar lengkap.