גישה למפות של ערכים מרכזיים ב-Node.js

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

אפשר להשתמש במודול apigee-access כדי לקבל את מפת ערכי המפתח של Edge (KVM) מתוך אפליקציה ב-Node.js. השיטה הזו לאחזור KVM היא חלופה לשימוש מפת ערכי המפתח מדיניות פעולות כדי לאחזר נתוני KVM בתהליך proxy ל-API.

מכונות KVM מספקות עקביות לטווח ארוך של צמדי מפתח/ערך שרירותיים שאפשר לאחזר באמצעות בסביבת זמן ריצה. לדוגמה, אפשר לאחסן ערכי מכסות, ערכי תפוגה של אסימון גישה ל-OAuth ו-OAuth רענון של ערכי התפוגה של אסימון ב-KVM לכל סביבת פריסה, ולאחר מכן אחזור של ערכים בקוד.

אפשר ליצור KVM באחד משלושת היקפי ההרשאות: organization, environment ו-apiproxy. לדוגמה, אם יוצרים KVM היקף apiproxy ל-"foo" רק "foo" שרת ה-proxy יכול לגשת ל-KVM. או אם תיצור KVM ב-"test" היקף הסביבה, כל שרתי ה-proxy ל-API שנפרסו ב'בדיקה' של ארגון הסביבה יכולה לגשת ל-KVM, אבל אף אחד משרתי ה-proxy שנפרסו ב-"prod" הסביבה יכולה לגשת אליו.

אחרי שיוצרים KVM עם ה-API לניהול, ממשק משתמש לניהול או פעולות מפת ערכי מפתח המדיניות שלנו (למידע נוסף, עיינו בקטע טווח ארוך שמירה במטמון), צריך להשתמש בפונקציות שכאן כדי לאחזר את הנתונים.

דפוס KVM מעולה זמין בכתובת https://community.apigee.com/content/kbentry/24906/a-pattern-for-caching-kvm-values.html.

להיכרות עם המודול apigee-access ושאר התכונות שלו: למידע נוסף שימוש ב-apigee-access מודול.

שיטות

השיטות הבאות פועלות גם במכונות KVM מוצפנות וגם לא מוצפנות.

• getKeyValueMap()
• getKeys()
• get()

getKeyValueMap

var kvm = apigee.getKeyValueMap('kvm_name', 'scope');
var kvm = apigee.getKeyValueMap('kvm_name', 'api', 'proxy_name');

אחזור KVM בהיקף מסוים (ארגון, סביבה, ממשק API או גרסה קודמת). אחרי מוחזר אובייקט KVM. משתמשים בפונקציות getKeys ו-get כדי להחזיר את שמות מפתחות או ערך מפתח ספציפי.

פרמטרים:

• kvm_name – שם ה-KVM שצריך לגשת אליו.
• scope – ההיקף של ה-KVM. אחד מהערכים organization, environment, api, או revision.
• proxy_name – היקף של api בלבד, שם ה-API שרת proxy.

החזרות:

אובייקט KVM.

דוגמה:

var apigee = require('apigee-access');
var kvm = apigee.getKeyValueMap('my_kvm', 'environment');

אם מגדירים את scope ל-api, נדרש פרמטר שלישי – השם של שרת ה-proxy ל-API. לדוגמה:

var kvm = apigee.getKeyValueMap('my_kvm', 'api', 'myApiProxy');

getKeys

מחזירה מערך שמכיל את השמות של כל המפתחות ב-KVM.

פרמטרים:

• callback: (חובה) פונקציית הקריאה החוזרת משתמשת בשני :
  • אובייקט Error אם הפעולה נכשלת.
  • אובייקט (keys_array בדוגמה שלמעלה) שמייצג את מערך של שמות מפתחות KVM.

החזרות:

מערך שמות של מפתחות KVM.

דוגמה:

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
}); 

הורדה

הפונקציה מקבלת את הערך של מפתח KVM.

פרמטרים:

• key: (חובה) מחרוזת שמזהה באופן ייחודי את הפריט שבמטמון.

• callback: (חובה) פונקציית הקריאה החוזרת משתמשת בשני :

  • אובייקט Error אם הפעולה נכשלת.
  • האובייקט שמכיל את ערך מפתח ה-KVM כמחרוזת.

דוגמה:

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);
});