Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

apigee-access モジュールの使用

The apigee-access module lets you access API proxy flow variables and caches from within Node.js application code. The module is included with the Apigee Edge platform; you do not need to install it as you would with other Node.js modules.

apigee-access の取得

apigee-access モジュールは、Apigee Edge プラットフォームに統合されています。Edge に Node.js コードを展開すると、このモジュールを使用できます。単に、展開する Node.js コードでこのモジュールが必要な場合があります。次に例を示します。

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

フロー変数へのアクセス

Edge に Node.js アプリケーションを展開すると、サポートされている「アウトオブボックス」のフロー変数、ポリシーによって作成されたフロー変数、Node.js コードでユーザーが独自に作成するフロー変数のすべてにアクセスできます。フロー変数が作成されると、Edge で実行されている API プロキシのコンテキスト内に存在します。詳細については、「Node.js でのフロー変数へのアクセス」を参照してください。

キャッシュへのアクセス

apigee-access モジュールを使用すると、Node.js コードから Apigee Edge の分散キャッシュにアクセスできます。詳細については、「Node.js でのキャッシュへのアクセス」を参照してください。

クォータサービスの使用

apigee-access モジュールを使用すると、Node.js コードから Apigee Edge のクォータサービスにアクセスできます。詳細については、「Node.js でのクォータサービスへのアクセス」を参照してください。

セキュアストアの使用

apigee-access モジュールを使用すると、Apigee Edge でバックエンドサービスのパスワードなどの機密データを暗号化フォーマットで格納できます。詳細については、「セキュアストアの使用」を参照してください。

ローカルモードでの実行と展開モードでの実行

ローカル開発とテストをサポートするため、apigee-access モジュールは、Apigee Edge に依存することなく「ローカルモード」で機能します。ただし、モジュールが Edge に展開されている API プロキシと併用されている場合は、「ローカル」機能は Edge のネイティブ機能に置き換わります。例えば、フロー変数の完全な長所は、展開モードでアクセスできることです。一方、Node.js アプリケーションでローカルに実行される場合は、小さなサブセットしか使用できません。これらのローカルモード変数のリストについては、以下の「ローカルモードでの実行」を参照してください。

モジュールが実行されているモードの特定

apigee-access が実行されているモードを特定するには、次のように指定します。

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

getMode() の戻り値では Node.js アプリケーションが Apigee Edge に展開されているか、スタンドアロンモードで実行されているかを伝えます。この方法では、次の 2 つの文字列の結果のいずれかが返されます。

  • apigee - Node.js アプリケーションが Apigee Edge で実行されており、すべての機能がサポートされています。
  • standalone - Node.js アプリケーションが Apigee Edge 環境外で実行されており、この文書の冒頭で説明したデフォルト機能が有効です。

展開モードでの実行

Edge に展開されると、ポリシーで設定された変数は apigee-access に表示され、このモジュールのメソッドによって追加または変更された変数は、プロキシのフローの後続のポリシーに表示されます。

変数リファレンスには、サポートされている変数のリンクがあります。これらの変数、およびユーザーが独自に作成した変数は 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 の「変数リファレンス」を参照してください。

テストに必要な変数が見つからない場合は、GitHub の問題として報告して頂くと、当社でその変数を追加したり、プルリクエストを送信したりできます。

 

Help or comments?