Truy cập vào bản đồ giá trị khoá trong Node.js

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Bạn có thể sử dụng mô-đun apigee-access để lấy dữ liệu bản đồ giá trị khoá (KVM) của Edge từ trong ứng dụng Node.js. Phương thức truy xuất KVM này là một phương án thay thế cho việc sử dụng Chính sách hoạt động của Bản đồ giá trị khoá để truy xuất dữ liệu KVM trong luồng proxy API.

KVM cung cấp tính năng lưu trữ lâu dài các cặp khoá/giá trị tuỳ ý mà bạn có thể truy xuất trong thời gian chạy. Ví dụ: bạn có thể lưu trữ giá trị hạn mức, giá trị hết hạn mã truy cập OAuth và giá trị hết hạn của mã làm mới OAuth trong KVM cho từng môi trường triển khai, sau đó truy xuất các giá trị trong mã của bạn.

Bạn có thể tạo KVM ở một trong ba phạm vi: organization, environment và apiproxy. Ví dụ: nếu bạn tạo một KVM ở phạm vi apiproxy cho proxy "foo", thì chỉ proxy "foo" mới có thể truy cập vào KVM; hoặc nếu bạn tạo một KVM ở phạm vi môi trường "test", thì tất cả proxy API được triển khai trong môi trường "test" của tổ chức đều có thể truy cập vào KVM, nhưng không có proxy nào được triển khai trong môi trường "prod" có thể truy cập vào KVM đó.

Sau khi bạn tạo một KVM bằng API quản lý, giao diện người dùng quản lý hoặc chính sách Hoạt động bản đồ giá trị khoá (xem phần Lưu vào bộ nhớ đệm lưu trữ dài hạn), hãy sử dụng các hàm tại đây để truy xuất dữ liệu.

Để biết một mẫu KVM hiệu quả, hãy xem https://community.apigee.com/content/kbentry/24906/a-pattern-for-caching-kvm-values.html.

Để biết phần giới thiệu về mô-đun apigee-access và các tính năng khác của mô-đun này, hãy xem phần Sử dụng mô-đun apigee-access.

Phương thức

Các phương thức sau đây hoạt động trên cả KVM đã mã hoá và chưa mã hoá.

getKeyValueMap

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

Truy xuất KVM ở một phạm vi cụ thể (tổ chức, môi trường, API hoặc bản sửa đổi). Sau khi đối tượng KVM được trả về, hãy sử dụng các hàm getKeys và get để trả về tên khoá hoặc một giá trị khoá cụ thể.

Các tham số:

  • kvm_name – Tên của KVM cần truy cập.
  • scope – Phạm vi của KVM. Một trong các giá trị organization, environment, api, hoặc revision.
  • proxy_name – Đối với phạm vi chỉ là api, tên của proxy API.

Trả về:

Một đối tượng KVM.

Ví dụ:

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

Nếu bạn đặt scope thành api, thì cần có thông số thứ ba, đó là tên của proxy API. Ví dụ: 

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

getKeys

var kvmKeys = apigee.getKeys(function(err, keys_array);

Trả về một mảng chứa tên của tất cả các khoá trong KVM.

Các tham số:

  • callback: (Bắt buộc) Hàm gọi lại sử dụng hai tham số:
    • Đối tượng Lỗi nếu thao tác không thành công.
    • Một đối tượng (keys_array trong ví dụ trên) đại diện cho آرایه tên khoá KVM.

Trả về:

Một mảng tên khoá KVM.

Ví dụ:

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

get

kvm.get('key', function(err, key_value));

Lấy giá trị của khoá KVM.

Các tham số:

  • key: (Bắt buộc) Một chuỗi xác định duy nhất một mục trong bộ nhớ đệm.

  • callback: (Bắt buộc) Hàm gọi lại sử dụng hai tham số:

    • Đối tượng Lỗi nếu thao tác không thành công.
    • Đối tượng chứa giá trị khoá KVM dưới dạng Chuỗi.

Ví dụ:

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