您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
简介
本主题介绍如何使用 apigee-access 从 Node.js 应用访问 Apigee Edge 配额服务。借助 apigee-access，您可以应用和重置配额值。
示例
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);
});
方法
应用
修改配额对象的设置。使用此方法可以增加或减少配额、更改时间间隔以及进行其他配置。
用法
var apigee = require('apigee-access');
var quota = apigee.getQuota();
quota.apply({parameters}, callback);
示例
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'); }
}
参数
apply() 方法带有两个参数：一个对象和一个函数：
(1) 第一个参数是包含以下字段的 JSON 对象：
- identifier（字符串，必填）：配额存储分区的唯一标识符。实际上，它可能是应用 ID、IP 地址或用户名。
- timeUnit（字符串，必填）：配额桶在重置之前将累计的时长。有效值为“minute”“hour”“day”“week”和“month”。
- allow（数字，必需）：配额存储分区的最大值。此值将与当前值结合使用，以返回配额是否成功。
- interval（数字，可选）：与“timeUnit”结合使用来确定重置配额多长时间。默认值为 1。设置为更大的值可允许配额，例如“两小时”“三周”等。
- weight（数字，可选）：配额递增的值。默认值为 1。
(2) 第二个参数是具有以下两个参数的回调函数：
- 如果配额无法增加，第一个参数是一个 Error 对象；如果操作成功，则未定义。
- 第二个是包含以下字段的对象：
- used（数字）：配额存储分区的当前值。
- allowed（数字）：在认为超出配额之前配额存储分区的最大值。相同的值作为“allow”在请求对象中传递。
- isAllowed（布尔值）：如果配额中还有剩余空间，则只要“used”小于或等于“allowed”，则为 true。
- expiryTime（长）：配额存储分区重置时的时间戳（以自 1970 年以来的格式，以毫秒为单位）。
- timestamp（长）：配额更新的时间戳。
示例
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'); }
}
重置
如需将配额重置为零，请调用 quota.reset()。此方法采用两个参数：-
包含以下字段的 JSON 对象：
- identifier（字符串，必填）：配额存储分区的唯一标识符。实际上，它可能是应用 ID、IP 地址或用户名。
- timeUnit（字符串，必填）：配额存储分区重置之前会累积的时长。有效值为“minute”“hour”“day”“week”和“month”。
- interval（数字，可选）：与“timeUnit”结合使用来确定重置配额多长时间。默认值为 1。设置为更大的值以允许重置时间，例如“2 小时”“3 周”等。
-
回调函数：
- 如果重置失败，则该回调函数会将 Error 对象作为第一个参数。
高级配额用例
创建配额时，您可以添加可选的“选项”对象。此对象有一个可选参数：- syncInterval（数字，可选）：分布式配额实现在整个网络中同步其状态的秒数。默认值为 10。