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

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. Thông tin

Bạn có thể dùng mô-đun apigee-access để lấy dữ liệu bản đồ giá trị khoá (KVM) Edge trong một ứ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 Thao tác với bản đồ khoá giá trị để truy xuất dữ liệu KVM trong một quy trình proxy API.

KVM cung cấp khả năng duy trì lâu dài các cặp khoá/giá trị tuỳ ý mà bạn có thể truy xuất tại thời gian chạy. Ví dụ: bạn có thể lưu trữ các giá trị hạn mức, giá trị hết hạn của mã truy cập OAuth và giá trị hết hạn của mã làm mới OAuth trong một 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 3 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ả các proxy API được triển khai trong môi trường "test" của một 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 KVM bằng API quản lý, giao diện người dùng quản lý hoặc chính sách Thao tác trên bản đồ khoá-giá trị (xem phần Lưu vào bộ nhớ đệm liên tục dài hạn), hãy sử dụng các hàm ở đây để truy xuất dữ liệu.

Để biết mẫu KVM tuyệt vời, hãy xem Mẫu lưu giá trị KVM vào bộ nhớ đệm.

Để biết thông tin 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 được mã hoá và không được mã hoá.

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

getKeyValueMap

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

Truy xuất mộ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 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ị sau: organization, environment, api, hoặc revision.
• proxy_name – Chỉ đối với scope của api, tên của proxy API.

Trả lại:

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ì bạn phải có tham số thứ ba – tên của proxy API. Ví dụ:

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

getKeys

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 callback sử dụng 2 tham số:
  • Một đố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 mảng tên khoá KVM.

Trả lại:

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

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

Các tham số:

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

• callback: (Bắt buộc) Hàm callback sử dụng 2 tham số:

  • Một đố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 một 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);
});