使用 apigee-access 模块

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

借助 apigee-access 模块，您可以从以下位置访问 API 代理流变量和缓存： Node.js 应用代码中该模块包含在 Apigee Edge 平台中；你不 您需要像安装其他 Node.js 模块一样安装该模块。

获取 apigee-access

apigee-access 模块已集成到 Apigee Edge 平台中。当您 将 Node.js 代码部署到 Edge，就可以使用此模块。只需在 您部署的任何 Node.js 代码。例如：

var access=require('apigee-access');

访问流变量

将 Node.js 应用部署到 Edge 后，你可以访问任何受支持的 &quot;out-of-the-box&quot;流变量、由政策创建的流变量以及 你可以直接在 Node.js 代码中自行创建。流变量在创建后存在于 在 Edge 上运行的 API 代理的上下文。如需了解详情，请参阅 通过 Google Cloud 控制台 Node.js。

访问缓存

借助 apigee-access 模块，您可以从以下位置访问 Apigee Edge 分布式缓存： Node.js 代码如需了解详情，请参阅在 Node.js 中访问缓存。

使用配额服务

通过 apigee-access 模块，您可以从自己的 Google Cloud 控制台 Node.js 代码。如需了解详情，请参阅 在 Google Cloud 控制台中访问配额服务 Node.js。

访问键值对映射

借助 apigee-access 模块，您可以从以下位置访问 Apigee Edge 键值对映射 (KVM)： Node.js 代码如需了解详情，请参阅 在以下位置访问键值对映射： Node.js。

在本地模式下运行与在部署模式下运行

为了支持本地开发和测试，apigee-access 模块 在 Apigee Edge 上没有依赖项的本地模式运行；不过， 当模块与 API 代理部署在 Edge（“本地”）功能已被原生 Edge 功能取代。例如， 可以在部署模式下访问完整的流变量，而 在本地运行 Node.js 应用时可用。有关这些局部模式变量的列表， 请参阅在本地模式下运行。

确定模块的运行模式

如需确定在哪种模式下运行 apigee-access：

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

getMode() 的返回值会告知您是否已部署 Node.js 应用 或以独立模式运行该方法会返回这两个字符串之一 结果：

  • apigee - Node.js 应用正在 Apigee Edge 及所有平台上运行 功能。
  • standalone - Node.js 应用正在 Apigee Edge 之外运行 而本文开头介绍的默认功能将 效果。

在部署模式下运行

部署到 Edge 后，由政策设置的变量对 apigee-access 可见， 并且由此模块的方法添加或修改的变量对 和代理流程

您可以在 变量参考。这些变量 apigee-access 可以看到您使用自己的名称创建的任何内容。注意事项 部分变量是只读的它们在 变量参考。

在本地模式下运行

在“本地模式”下您在 Apigee Edge 上下文之外运行 Node.js 代码。在 在 Node.js 环境中无法访问大多数预定义的流变量 代码。下表显示了一小部分可用的流变量。这些变量 以支持 Node.js 应用的本地开发和测试

变量 只读 类型 备注
client.received.start.time 是 字符串 收到请求的时间
client.received.end.time 是 字符串 收到请求的时间
client.received.start.timestamp 是 整数 收到请求的时间
client.received.end.timestamp 是 整数 收到请求的时间

同样，Apigee Edge 平台支持更多的预定义变量。 参阅 Apigee Edge 变量 参考文档。