您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
apigee-access
模組可讓您從 Node.js 應用程式程式碼存取 API Proxy 流程變數和快取。Apigee Edge 平台內含這個模組,您不必像其他 Node.js 模組一樣進行安裝。
取得 apigee-存取
apigee-access
模組已整合至 Apigee Edge 平台。當您將 Node.js 程式碼部署至 Edge 時,可以使用這個模組。只要在您部署的任何 Node.js 程式碼中要求即可。例如:
var access=require('apigee-access');
存取流程變數
將 Node.js 應用程式部署至 Edge 時,您可以存取任何支援的「立即可用」流程變數、由政策建立的流程變數,以及您透過 Node.js 程式碼自行建立的任何流程變數。流程變數會建立流程變數,並在 Edge 的 API Proxy 環境中建立。詳情請參閱「在 Node.js 中存取流程變數」一文。
存取快取
apigee-access
模組可讓您從 Node.js 程式碼存取 Apigee Edge 分散式快取。詳情請參閱在 Node.js 中存取快取。
使用配額服務
apigee-access
模組可讓您透過 Node.js 程式碼存取 Apigee Edge 配額服務。詳情請參閱「在 Node.js 中存取配額服務」一文。
存取鍵/值對應
apigee-access
模組可讓您從 Node.js 程式碼存取 Apigee Edge 金鑰值對應 (KVM)。詳情請參閱「在 Node.js 中存取鍵/值對應」一文。
以本機模式與部署模式執行
為支援本機開發和測試,apigee-access
模組可在 Apigee Edge 上無需依附元件的「本機模式」運作;不過,如果模組的 API Proxy 是部署至 Edge 的 API Proxy,則「本機」功能會由原生 Edge 功能取代。舉例來說,您可以在部署模式下存取完整流程變數,但在本機執行 Node.js 應用程式時,只能使用一小部分。如需這些本機模式變數的清單,請參閱以本機模式執行。
確定執行模組的模式
要判斷您在哪個模式下執行 apigee-存取:
var access = require('apigee-access') console.log('The deployment mode is ' + access.getMode());
getMode() 傳回值會指出 Node.js 應用程式是否已部署至 Apigee Edge,還是以獨立模式執行。這個方法會傳回下列其中一個字串結果:
apigee
- 在 Apigee Edge 上執行 Node.js 應用程式,且支援所有功能。standalone
:Node.js 應用程式是在 Apigee Edge 環境外執行,因此文件頂端描述的預設功能會生效。
以部署模式執行
部署至 Edge 時,apigee-access
可以查看由政策設定的變數,而這個模組方法新增或修改的變數也會顯示在 Proxy 流程中。
您可以在變數參考資料中找到支援的變數連結。apigee-access
可以看到這些變數,以及您以自己的名稱建立的任何變數。請注意,部分變數處於唯讀狀態。如需識別這些變數,請參閱變數參考資料。
以本機模式執行
在「本機模式」中,您是在 Apigee Edge 之外執行 Node.js 程式碼。在這個模式下,您無法在 Node.js 程式碼中存取大部分預先定義的流程變數。此表格顯示可用的一小部分流程變數。這裡支援這些變數,以便支援 Apigee Edge 適用的 Node.js 應用程式的本機開發及測試作業。
變數 | 唯讀 | 類型 | 備忘錄 |
client.received.start.time |
是 | 字串 | 收到要求的時間 |
client.received.end.time |
是 | 字串 | 收到要求的時間 |
client.received.start.timestamp |
是 | 整數 | 收到要求的時間 |
client.received.end.timestamp |
是 | 整數 | 收到要求的時間 |
同樣,在 Apigee Edge 平台上,支援更多的預先定義變數。 如需完整清單,請參閱 Apigee Edge 變數參考資料。