Использование модуля apigee-access

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X.
информация

Модуль apigee-access позволяет получать доступ к переменным потока и кэшам прокси-сервера API из кода приложения Node.js. Модуль входит в состав платформы Apigee Edge; вам не нужно устанавливать его, как другие модули Node.js.

Получение apigee-доступа

Модуль apigee-access интегрирован в платформу Apigee Edge. Когда вы развертываете код Node.js в Edge, этот модуль становится вам доступен. Вам просто нужно указать его в любом развертываемом коде Node.js. Например:

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

Доступ к переменным потока

Когда вы развертываете приложение Node.js в Edge, вы можете получить доступ к любым поддерживаемым «готовым» переменным потока, переменным потока, созданным политиками, и любым переменным потока, которые вы создаете самостоятельно из вашего Node.js. код. Переменные потока создаются и существуют в контексте прокси-сервера API, работающего в Edge. Подробную информацию см. в разделе Доступ к переменным потока в 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, развернутым в Edge , «локальная» функциональность заменяется собственной функциональностью Edge. Например, полный набор переменных потока доступен в развернутом режиме, тогда как при локальном запуске приложения Node.js доступно только небольшое подмножество. Список этих переменных локального режима см. в разделе «Выполнение в локальном режиме» .

Определение режима, в котором работает модуль

Чтобы определить, в каком режиме вы используете apigee-access:

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

Возвращаемое значение getMode() сообщает вам, развернуто ли приложение Node.js в Apigee Edge или работает в автономном режиме. Метод возвращает один из этих двух строковых результатов:

  • apigee — приложение Node.js работает на Apigee Edge, и все его функции поддерживаются.
  • standalone — приложение Node.js выполняется вне среды Apigee Edge, и вступают в силу функции по умолчанию, описанные в верхней части документа.

Запуск в развернутом режиме

При развертывании в Edge переменные, установленные политиками, видны apigee-access , а переменные, добавленные или измененные методами этого модуля, видны последующим политикам в потоке прокси.

Ссылку на поддерживаемые переменные можно найти в Справочнике переменных . Эти переменные, а также все, что вы создаете под своими именами, видны apigee-access . Обратите внимание, что некоторые переменные доступны только для чтения. Они указаны в Справочнике переменных .

Запуск в локальном режиме

В «локальном режиме» вы запускаете код Node.js вне контекста Apigee Edge. В этом режиме большинство предопределенных переменных потока недоступны в вашем коде Node.js. В этой таблице показано небольшое подмножество доступных переменных потока. Эти переменные поддерживаются здесь для поддержки локальной разработки и тестирования приложений Node.js для Apigee Edge.

Переменная Только чтение Тип Примечания
client.received.start.time Да Нить Время получения запроса
client.received.end.time Да Нить Время получения запроса
client.received.start.timestamp Да Целое число Время получения запроса
client.received.end.timestamp Да Целое число Время получения запроса

Опять же, на платформе Apigee Edge поддерживается гораздо больший набор предопределенных переменных. Полный список см. в Справочнике переменных Apigee Edge.