Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Giới thiệu
Chủ đề này giải thích cách sử dụng apigee-access để truy cập vào dịch vụ hạn mức Apigee Edge từ ứng dụng Node.js. Với quyền truy cập apigee, bạn có thể áp dụng và đặt lại giá trị hạn mức.
Ví dụ:
var apigee = require('apigee-access');
var quota = apigee.getQuota();
quota.apply({ identifier: 'Foo', allow: 10, timeUnit: 'hour' },
function(err, result) {
console.log('Quota applied: %j', result);
});
Phương thức
áp dụng
Sửa đổi chế độ cài đặt trên đối tượng Hạn mức. Sử dụng phương thức này để tăng hoặc giảm hạn mức, thay đổi khoảng thời gian và thực hiện các cấu hình khác.
Cách sử dụng
var apigee = require('apigee-access');
var quota = apigee.getQuota();
quota.apply({parameters}, callback);
Ví dụ:
var apigee = require('apigee-access');
var quota = apigee.getQuota();
// Apply a quota of 100 requests per hour
quota.apply({
identifier: 'Foo',
timeUnit: 'hour',
allow: 100
}, quotaResult);
function quotaResult(err, r) {
if (err) { console.error('Quota failed'); }
}
Thông số
Phương thức apply() nhận 2 tham số: một đối tượng và một hàm:
(1) Tham số đầu tiên là một đối tượng JSON có các trường sau:
- mã nhận dạng (chuỗi, bắt buộc): Giá trị nhận dạng duy nhất của bộ hạn mức. Trong thực tế, đó có thể là mã ứng dụng, địa chỉ IP hoặc tên người dùng.
- timeUnit (chuỗi, bắt buộc): Khoảng thời gian tích luỹ bộ chứa hạn mức cho đến khi bộ chứa được đặt lại. Các giá trị hợp lệ là "phút", "giờ", "ngày", "tuần" và "tháng".
- allow (số, bắt buộc): Giá trị tối đa cho bộ hạn mức. Giá trị này sẽ được kết hợp với giá trị hiện tại để trả về việc hạn mức có thành công hay không.
- interval (số, không bắt buộc): Kết hợp với "timeUnit" để xác định khoảng thời gian trước khi hạn mức được đặt lại. Giá trị mặc định là 1. Đặt thành một giá trị lớn hơn để cho phép các hạn mức như "2 giờ", "3 tuần", v.v.
- weight (số, không bắt buộc): Giá trị để tăng hạn mức. Giá trị mặc định là 1.
(2) Đối số thứ hai là một hàm callback với hai đối số sau:
- Đối số đầu tiên là một đối tượng Lỗi nếu không thể tăng hạn mức hoặc không xác định nếu thao tác thành công.
- Đối tượng thứ hai là một đối tượng chứa các trường sau:
- used (số): Giá trị hiện tại của bộ hạn mức.
- allowed (số): Giá trị tối đa của bộ chứa hạn mức trước khi hạn mức được coi là đã vượt quá. Giá trị tương tự được truyền dưới dạng "allow" (cho phép) trong đối tượng yêu cầu.
- isAllowed (boolean): Nếu vẫn còn chỗ trong hạn mức, miễn là "used" phải nhỏ hơn hoặc bằng "cho phép".
- expiryTime (long): Dấu thời gian, tính bằng mili giây kể từ định dạng năm 1970, khi bộ chứa hạn mức sẽ được đặt lại.
- timestamp (long): Dấu thời gian cập nhật hạn mức.
Ví dụ:
var apigee = require('apigee-access');
var quota = apigee.getQuota();
// Apply a quota of 100 requests per hour
quota.apply({
identifier: 'Foo',
timeUnit: 'hour',
allow: 100
}, quotaResult);
// Apply a quota of 500 requests per five minutes
quota.apply({
identifier: 'Bar',
timeUnit: 'minute',
interval: 5,
allow: 500
}, quotaResult);
// Increment the quota by a value of 10
quota.apply({
identifier: 'Foo',
timeUnit: 'hour',
allow: 100,
weight: 10
}, quotaResult);
function quotaResult(err, r) {
if (err) { console.error('Quota failed'); }
}
đặt lại
Để đặt lại hạn mức về 0, hãy gọi quota.reset(). Phương thức này có hai tham số:-
Một đối tượng JSON có các trường sau:
- identifier (chuỗi, bắt buộc): Giá trị nhận dạng duy nhất của bộ chứa hạn mức. Trong thực tế, đó có thể là mã ứng dụng, địa chỉ IP hoặc tên người dùng.
- timeUnit (chuỗi, bắt buộc): Khoảng thời gian tích luỹ của bộ hạn mức cho đến khi bộ hạn mức đó được đặt lại. Các giá trị hợp lệ là "phút", "giờ", "ngày", "tuần" và "tháng".
- interval (số, không bắt buộc): Kết hợp với "timeUnit" để xác định thời gian trước khi đặt lại hạn mức. Giá trị mặc định là 1. Đặt thành một giá trị lớn hơn để cho phép đặt lại thời gian như "2 giờ", "3 tuần", v.v.
-
Hàm callback:
- Lệnh gọi lại sẽ lấy đối tượng Lỗi làm tham số đầu tiên nếu không đặt lại được.
Trường hợp sử dụng Hạn mức nâng cao
Khi tạo hạn mức, bạn có thể thêm một đối tượng "options" (không bắt buộc). Đối tượng này có một tham số không bắt buộc:- syncInterval (số, không bắt buộc): Số giây mà phương thức triển khai hạn mức phân phối đồng bộ hoá trạng thái của phương thức đó trên mạng. Giá trị mặc định là 10.