使用 apigee-access 模組

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

apigee-access 模組可讓您從以下項目存取 API Proxy 流程變數和快取: 導入及設定狀態這個模組隨附於 Apigee Edge 平台。你不是 必須像處理其他 Node.js 模組一樣。

取得 apigee-access

apigee-access 模組已整合至 Apigee Edge 平台。當您 您可以將 Node.js 程式碼部署至 Edge,就可以使用這個模組。您只需要在 您部署的任何 Node.js 程式碼例如:

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

存取流程變數

將 Node.js 應用程式部署至 Edge 後,您就能存取 "out-of-the-box"流程變數、由政策建立的流程變數,以及 建立自己的節點流程變數會建立並存在於 並在 Edge 上執行 API Proxy 的環境如需詳細資訊,請參閲 在 Node.js

存取快取

apigee-access 模組可讓您存取 Apigee Edge 的分散式快取 您的 Node.js 程式碼。詳情請參閱「在 Node.js 中存取快取」。

使用配額服務

apigee-access 模組可讓您透過以下項目存取 Apigee Edge 配額服務: Node.js 程式碼。如需詳細資訊,請參閲 存取 Node.js

存取鍵/值對應

您可以透過 apigee-access 模組存取 Apigee Edge 金鑰值對應關係 (KVM),方法是 您的 Node.js 程式碼。如需詳細資訊,請參閲 在 Node.js

以本機模式與已部署模式執行

如要支援本機開發和測試,apigee-access 模組 以「本機模式」運作,不依賴 Apigee Edge 上的依附元件;不過 當模組與部署在內部的 API Proxy 搭配使用時 Edge,「local」會由原生 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 可以查看政策設定的變數, 以及由這個模組方法新增或修改的變數,會顯示在 存取 Proxy 流程

您可以在 變數參考資料。這些變數 「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 變數 完整清單的參考資料