Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Anda dapat menggunakan modul apigee-access
untuk mendapatkan peta nilai kunci Edge (KVM)
data dari dalam aplikasi Node.js. Metode pengambilan KVM ini
adalah alternatif dari menggunakan
Peta Nilai Kunci,
{i>Key Value Map<i}
Kebijakan operasi untuk mengambil data KVM dalam alur proxy API.
KVM menyediakan persistensi jangka panjang atas key-value pair arbitrer yang dapat Anda ambil waktu beroperasi. Misalnya, Anda dapat menyimpan nilai kuota, nilai masa berlaku token akses OAuth, dan OAuth memperbarui nilai habis masa berlaku token di KVM untuk setiap lingkungan deployment, lalu mengambil dalam kode Anda.
Anda dapat membuat KVM di salah satu dari tiga cakupan: organization
,
environment
, dan apiproxy
. Misalnya, jika Anda membuat KVM di
cakupan apiproxy untuk "foo" hanya kata "foo" {i>proxy<i} dapat mengakses KVM; atau jika Anda membuat
di "test" (pengujian) semua proxy API yang di-deploy dalam "pengujian" organisasi
yang dapat mengakses KVM, tetapi tidak ada
proxy yang di-deploy dalam "prod" lingkungan dapat
mengaksesnya.
Setelah membuat KVM dengan API pengelolaan, UI pengelolaan, atau Operasi Peta Nilai Kunci kebijakan (lihat Jangka panjang cache persistensi), gunakan fungsi di sini untuk mengambil data.
Untuk mengetahui pola KVM yang bagus, lihat https://community.apigee.com/content/kbentry/24906/a-pattern-for-caching-kvm-values.html.
Untuk pengantar modul apigee-access
dan fitur lainnya,
lihat Menggunakan apigee-access
modul.
Metode
Metode berikut berfungsi pada KVM yang dienkripsi dan tidak dienkripsi.
getKeyValueMap
var kvm = apigee.getKeyValueMap('kvm_name', 'scope'); var kvm = apigee.getKeyValueMap('kvm_name', 'api', 'proxy_name');
Mengambil KVM pada cakupan tertentu (organisasi, lingkungan, api, atau revisi). Setelah
Objek KVM ditampilkan, gunakan fungsi getKeys
dan get
untuk menampilkan
nama kunci atau
nilai kunci tertentu.
Parameter:
- kvm_name - Nama KVM yang akan diakses.
- cakupan - Cakupan KVM. Salah satu dari
organization
,environment, api,
ataurevision
. - proxy_name - Untuk cakupan api, nama API {i>proxy<i}.
Hasil:
Objek KVM.
Contoh:
var apigee = require('apigee-access'); var kvm = apigee.getKeyValueMap('my_kvm', 'environment');
Jika Anda menetapkan scope ke api, parameter ketiga diperlukan - nama proxy API. Contoh:
var kvm = apigee.getKeyValueMap('my_kvm', 'api', 'myApiProxy');
getKeys
var kvmKeys =
apigee.getKeys(function(err, keys_array);
Mengembalikan larik yang berisi nama semua kunci dalam KVM.
Parameter:
-
callback
: (Wajib) Fungsi callback menggunakan dua parameter:- Objek Error jika operasi gagal.
- Objek (
keys_array
dalam contoh di atas) yang mewakili himpunan nama kunci KVM.
Hasil:
Array nama kunci KVM.
Contoh:
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 });
dapatkan
kvm.get('key', function(err,
key_value));
Mendapatkan nilai kunci KVM.
Parameter:
-
key
: (Wajib) String yang mengidentifikasi secara unik item dalam cache. -
callback
: (Wajib) Fungsi callback menggunakan dua parameter:- Objek Error jika operasi gagal.
- Objek yang berisi nilai kunci KVM sebagai String.
Contoh:
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); });