Справочник переменных процесса

Общее имя, указанное в сертификате TLS/SSL, предоставленном клиентским приложением.

Страна в сертификате TLS/SSL, предоставленном клиентским приложением.

Адрес электронной почты в сертификате TLS/SSL, предоставленном клиентским приложением.

IP-адрес хоста HTTP, связанный с запросом, полученным ProxyEndpoint.

IP-адрес клиента или системы, отправляющей сообщение на пограничный маршрутизатор. Например, это может быть исходный IP-адрес клиента или IP-адрес балансировщика нагрузки.

Местоположение (город) в сертификате TLS/SSL, предоставленном клиентом.

Организационное подразделение в сертификате TLS/SSL, предоставленном клиентом.

HTTP-порт, связанный с исходным клиентским запросом к ProxyEndpoint.

Время, выраженное в виде строки, когда прокси-сервер завершил получение запроса от исходного клиента в ProxyEndpoint. Пример: Wed, 21 Aug 2013 19:16:47 UTC.

Это значение времени представляет собой строковое представление соответствующего 32-битного временного штампа. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению 1377112607413.

Временная метка, указывающая, когда прокси-сервер завершил получение запроса от исходного клиента в ProxyEndpoint. Это 64-битное целое число, содержащее количество миллисекунд, прошедших с полуночи 1 января 1970 г. (UTC).

Время, выраженное в виде строки, когда прокси-сервер начал получать запрос от исходного клиента в ProxyEndpoint. Пример: Wed, 21 Aug 2013 19:16:47 UTC

Это значение времени представляет собой строковое представление соответствующего 32-битного временного штампа. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению 1377112607413.

Временная метка, указывающая, когда прокси-сервер начал получать запрос от исходного клиента в ProxyEndpoint. Это 64-битное целое число, содержащее количество миллисекунд, прошедших с полуночи 1 января 1970 г. (UTC).

Возвращает http или https в зависимости от транспорта, используемого клиентским приложением для отправки запроса.

Время, выраженное в виде строки, когда прокси-сервер завершил отправку ответа из ProxyEndpoint клиенту. Пример: "Wed, 21 Aug 2013 19:16:47 UTC".

Это строковое представление соответствующего 32-битного значения client.sent.end.timestamp. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению 1377112607413.

Это строковое представление соответствующего 32-битного значения client.sent.start.timestamp. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению 1377112607413.

"true", если ProxyEndpoint настроен для TLS/SSL; в противном случае – "false".

Штат в сертификате TLS/SSL, предоставленном клиентом.

Сообщение, связанное с ошибкой. Его значение доступно только до выполнения потока ошибок.

Код статуса HTTP, связанный с ошибкой. Пример: 400.

Фраза, связанная с ошибкой. Пример: "Неверный запрос".

Любая ошибка типа TransportMessage.

Состояние в потоке, в котором произошла ошибка.

Получение или установка заголовка ответа.

Флаг ошибки.

Список TargetServer, которые не удалось сбалансировать при балансировке нагрузки в TargetEndpoint.

"true", если для TargetServer, вызванного во время балансировки нагрузки в TargetEndpoint, включен резервный режим.

TargetServer, вызванный во время балансировки нагрузки в TargetEndpoint. Указывается, только если при определении элемента балансировщика нагрузки задан элемент <Path>.

Контекстный объект с тем же значением, что и request в запросе Flow, response в ответе Flow или error в потоке Error.

Содержание запроса, ответа или сообщения об ошибке.

Значение указанного параметра формы.

Все значения указанного параметра формы в письме.

Количество значений указанных параметров формы в сообщении./p>

Количество всех параметров формы в письме.

Значение всех параметров формы в сообщении.

Значение строки формы в письме.

Получает или задает значение указанного HTTP-заголовка в письме. Если в заголовке есть запятая, при чтении вы получите только часть текста до первой запятой. Если вам нужен весь заголовок, используйте форму request.header.header_name.
 values.

Значение N-го заголовка в сообщении (запросе или ответе) в зависимости от состояния потока. Apigee Edge разделяет текстовые значения заголовков запятыми. Обратите внимание, что индекс, значение которого используется для N, начинается с 1, а не с 0.

Например, если заголовок Cache-control имеет значение "public,maxage=16544", то возвращаемое значение message.header.cache-control.1 будет "maxage=16544".

Все значения указанного заголовка HTTP в письме.

Количество значений указанного заголовка HTTP в письме.

Количество всех заголовков HTTP в письме.

Значение всех HTTP-заголовков в письме

Полный путь сообщения запроса в URL, за исключением параметров запроса.

Возвращает указанный параметр запроса сообщения.

Значение параметра запроса Nth в сообщении. Например, если request.querystring имеет значение "a=hello&a=world", то функция message.queryparam.a.1 вернет значение "hello".

Например, если вы хотите указать несколько значений для одного параметра запроса, например "type=siteid:1&type=language:us-en&type=currency:USD", задайте следующие значения:

• message.queryparam.type.1: новое значение – "siteid:1".
• message.queryparam.type.2 на "language:en-us"
• message.queryparam.type.3 к "currency:USD"

Все значения определенного параметра запроса в сообщении, отформатированные как список, разделенный запятыми.

Например, если строка запроса – a=hello&a=world, то значение message.queryparam.a.values будет "['hello', 'world']".

Общее количество указанных параметров запроса, связанных с запросом, отправленным в ProxyEndpoint из клиентского приложения.

Общее количество всех параметров запроса, связанных с запросом, отправленным в ProxyEndpoint из клиентского приложения.

Список всех названий параметров запроса, связанных с запросом, отправленным в ProxyEndpoint из клиентского приложения.

Чтобы перебрать названия параметров запроса с помощью JavaScript, ознакомьтесь с записью в сообществе Apigee: Как перебрать коллекцию из "request.queryparams.names" в JS? в сообществе Apigee.

Строка, содержащая все названия и значения параметров запроса, связанные с запросом, отправленным в ProxyEndpoint из клиентского приложения.

Например, для запроса http://api.apifactory.com/inventors?name=nick&surname=danger значением message.querystring будет "name=nick&surname=danger".

ReasonPhrase ответного сообщения от целевого объекта.

Код статуса HTTP сообщения ответа от целевого сервиса.

Сообщение типа TransportMessage, которое является контекстным объектом.

Полный путь URI (после URL домена), включая параметры запроса.

Например, для запроса "http://api.apifactory.com/inventors?name=nikola&surname=tesla" эта переменная возвращает значение "inventors?name=nikola&surname=tesla".

HTTP-команда (GET, PUT, POST, DELETE и т. д.), связанная с запросом.

Версия HTTP, связанная с запросом, отправленным в ProxyEndpoint из клиентского приложения.

Содержит уникальный идентификатор запроса, включающий имя хоста маршрутизатора. Этот идентификатор позволяет отслеживать запросы, полученные маршрутизатором, после того, как они будут отправлены обработчику сообщений.

Этот идентификатор регистрируется в журналах ошибок Edge, чтобы сопоставить messageid с ошибками.

Название организации.

Значение базового пути в конфигурации прокси API. Базовый путь – это фрагмент URI, который следует за хостом в URL. URI условных потоков следуют базовому пути.

В URL http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282":

• Хост – myorg-test.apigee.net (включает название организации и среды).
• Базовый путь – "/v2/weatherapi".

Узнать об этом можно, только посмотрев определение прокси-сервера API или проверив значение переменной proxy.basepath. Суффикс пути прокси-сервера следует за базовым путем ("/forecastrss") и любыми параметрами запроса.

Если в конфигурации прокси API задан динамический базовый путь, например "/v2/*/weatherapi", то эта переменная будет иметь значение динамического пути ("/v2/*/weatherapi"), даже если базовый путь разрешается в статическое значение, например "/v2/foo/weatherapi".

Адрес X-Forwarded-For входящего звонка, который представляет собой IP-адрес, полученный Edge от последнего внешнего рукопожатия TCP. Это может быть вызывающий клиент или балансировщик нагрузки.

Атрибут name, настроенный для ProxyEndpoint.

Значение суффикса базового пути прокси-сервера API, отправленное клиентом и полученное в ProxyEndpoint.

Базовый путь – это компонент пути, который однозначно идентифицирует прокси-сервер API. Публичный URL прокси-сервера API состоит из названия организации, среды, в которой развернут прокси-сервер, базового пути, суффикса базового пути и любых параметров запроса.

Например, в запросе к http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282 суффикс базового пути – "/forecastrss".

Возвращает полный URL, связанный с запросом прокси, полученным ProxyEndpoint, включая все параметры запроса. Если прокси-сервер вызывается с помощью <LocalTargetConnection> для выполнения цепочки прокси-серверов, хостом URL всегда будет localhost.

Пример создания URL request с использованием исходного хоста приведен в разделе Запросы на доступ.

Возвращает время UTC (в миллисекундах), когда истекает квота и начинается новый интервал квоты.

Если для правила квоты задан тип rollingwindow, это значение недопустимо, поскольку интервал квоты не истекает.

Указывает, не удалось ли применить правило (true или false).

Полный запрос, включая все полезные данные.

Получает или задает полезную нагрузку запроса.

Получает или задает значение указанного параметра формы в запросе, отправленном из клиентского приложения.

Все значения определенного параметра формы в запросе, отформатированные как список, разделенный запятыми.

Например, если полезная нагрузка имеет вид "a=hello&x=greeting&a=world", то значение request.formparam.a.values будет "['hello', 'world']".

Количество всех значений указанного параметра формы, связанных с запросом.

Значение N-го параметра формы в сообщении. Например, если строка формы имеет вид "a=hello&a=world", то возвращаемое значение request.formparam.a.1 будет равно "hello".

Количество всех параметров формы, связанных с запросом, отправленным из клиентского приложения.

Список всех названий параметров формы, связанных с запросом.

Полный тег formparam в запросе, отправленном из клиентского приложения.

Например, "name=test&type=first&group=A".

Получает или задает значение определенного заголовка, найденного в запросе. Если в заголовке есть запятая, при чтении вы получите только часть текста до первой запятой.

Если вам нужен весь заголовок, используйте форму request.header.header_name.values.

Значение N-го заголовка в запросе. Apigee Edge разделяет значения заголовков запятыми. Обратите внимание, что индекс, значение которого используется для N, начинается с 1, а не с 0.

Например, если заголовок Cache-control имеет значение "public, maxage=16544", то функция request.header.cache-control.1 вернет значение "maxage=16544".

Все значения определенного заголовка в запросе.

Количество всех значений определенного заголовка в запросе.

Количество всех заголовков в запросе.

Названия всех заголовков в запросе.

Путь к ресурсу без прокси-сервера (без учета хоста) для бэкенд-службы, исключая параметры запроса.

Например, если URI бэкенд-службы – "https://example.com/rest/api/latest", то значением request.path будет "/rest/api/latest".

Значение определенного параметра запроса, найденного в запросе.

Значение параметра запроса Nth в запросе.

Например, если request.querystring – "a=hello&a=world", то возвращаемое значение request.queryparam.a.1 – "hello".

Например, если вы хотите указать несколько значений для одного параметра запроса, например "type=siteid:1&type=language:us-en&type=currency:USD", задайте следующие значения:

• request.queryparam.type.1: новое значение – "siteid:1".
• request.queryparam.type.2 на "language:en-us"
• request.queryparam.type.3 к "currency:USD"

Все значения определенного параметра запроса в запросе, отформатированные как список, разделенный запятыми.

Например, если request.querystring – "a=hello&b=lovely&a=world", то значением request.queryparam.a.values будет "['hello', 'world']".

Количество всех значений определенного параметра запроса в запросе.

Количество всех параметров запроса.

Названия всех параметров запроса.

Чтобы перебрать названия параметров запроса с помощью JavaScript, ознакомьтесь со статьей Как перебрать коллекцию из "request.queryparams.names" в JS? в сообществе Apigee.

Полный список параметров запроса, отправленного из клиентского приложения.

Например, если запрос имеет вид "http://host.com/123?name=first&surname=second&place=address", то эта переменная возвращает значение "name=first&surname=second&place=address".

Идентификатор запроса в виде объекта TransportMessage, который является контекстным объектом.

Запрос типа TransportMessage, который является контекстным объектом.

В прокси-сервере API прокси-путь <BasePath> в ProxyEndpoint (в дополнение к базовому URL прокси-сервера) сопоставляется с URL целевого сервиса в TargetEndpoint. Пример:

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

На что указывает

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

В запросе request.uri – это базовый путь прокси-сервера + остаток адреса, включая параметры запроса.

В ответе request.uri – это остаток адреса, включая параметры запроса, после HTTPTargetConnection.

Это связано с тем, что исходный запрос поступил на прокси-сервер, а затем прокси-сервер отправил другой запрос целевому сервису.

Предположим, что к нашему образцу прокси-сервера с базовым путем "/my-mock-proxy" выполняется следующий вызов:

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

Прокси-сервер вызывает:

http://mocktarget.apigee.net

который добавляет к этому URL строку "/user?user=Dude".

• Запрос: request.uri = "/my-mock-proxy/user?user=Dude"
• Ответ: request.uri = "/user?user=Dude"

Полный URL запроса, отправленного в целевую конечную точку, включая параметры строки запроса, но без номера порта (если он указан).

Например, если вы вызываете образец прокси-сервера "http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude", а целевая конечная точка – "http://example.com:8080", то значение будет следующим:

• Запрос: н/д
• Ответ: "http://example.com/user?user=Dude"

Глагол HTTP, использованный в запросе. Примеры: GET, PUT и DELETE.

Версия HTTP-запроса. Пример: 1.1.

Полный ответ, возвращенный целевым сервисом.

Содержимое полезной нагрузки ответного сообщения, возвращенного целевым объектом.

Значение параметра формы в ответе.

Количество всех значений указанного параметра формы в ответе.

Количество всех параметров формы в ответе.

Названия всех параметров формы в ответе.

Получает или задает значение указанного заголовка HTTP в ответе.

Если в тексте заголовка есть запятая, Apigee Edge распознает несколько значений. В этом случае функция response.header.header_name возвращает только первое значение.

Чтобы прочитать весь заголовок, используйте форму response.header.header_name.values.

Все значения указанного заголовка HTTP в ответе.

Количество всех значений указанного заголовка HTTP в ответе.

Значение N-го заголовка в ответе. Apigee Edge разделяет значения заголовков запятыми. Обратите внимание, что индекс, значение которого используется для N, начинается с 1, а не с 0.

Например, если заголовок Cache-control имеет значение "public, maxage=16544", то функция response.header.cache-control.1 вернет значение "maxage=16544".

Количество всех заголовков в ответе.

Названия всех заголовков в ответе.

Фраза с причиной ответа на определенный запрос.

Код ответа, возвращенный для запроса. С помощью этой переменной можно переопределить код статуса ответа, который хранится в message.status.code. Дополнительную информацию вы найдете здесь: message.

Ответ типа TransportMessage, который является контекстным объектом.

Название <RouteRule>, которое было выполнено в ProxyEndpoint. Пример: "default". RouteRule ссылается на TargetEndpoint прокси-сервера API для выполнения.

Название выполненной конечной точки целевого сервиса. Пример: default.

Устаревший метод, возвращающий значение NULL. (Ранее – UUID роутера, обрабатывающего прокси.)

Ожидаемое общее имя TargetEndpoint, указанное в правиле ServiceCallout. Это имеет смысл, только если TargetEndpoint относится к конечной точке TLS/SSL.

URL TargetEndpoint для определенного правила ServiceCallout.

URI TargetEndpoint для правила ServiceCallout policy. URI – это URL TargetEndpoint без протокола и спецификации домена.

IP-адрес системы.

Название пода, в котором работает прокси-сервер.

Название центра обработки данных региона, в котором работает прокси-сервер.

Время, когда была прочитана эта переменная. Пример: "Wed, 21 Aug 2013 19:16:47 UTC".

Это строковое представление соответствующего значения атрибута "цена" system.timestamp. Например, "Wed, 21 Aug 2013 19:16:47 UTC" соответствует временной метке "1377112607413".

Год в дате system.time.

Месяц в дате system.time.

День месяца в system.time.

День недели в формате system.time.

Часть времени system.time, обозначающая час.

Минутная часть значения system.time.

Вторая часть system.time.

Миллисекунды в значении system.time.

Часовой пояс системы.

64-битное целое число (long), представляющее время, когда была прочитана эта переменная. Значение – это количество миллисекунд, прошедших с полуночи 1 января 1970 г. (UTC). Пример: "1534783015000".

UUID обработчика сообщений, который управляет прокси-сервером.

Путь к ресурсу (без домена) целевого сервиса, исключая параметры запроса, который определен в TargetEndpoint прокси.

Предположим, что прокси-сервер API вызывает следующий целевой сервис:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

В этом примере target.basepath – это "/user".

Если бы целевой показатель был таким:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

Значение target.basepath будет равно null.

Если задано значение true, запрос, перенаправленный из ProxyEndpoint в TargetEndpoint, сохраняет суффикс пути (фрагмент пути URI, следующий за URI, определенным в базовом пути ProxyEndpoint).

Если задано значение true, запрос, перенаправленный из ProxyEndpoint в TargetEndpoint, сохраняет параметры запроса.

Страна, указанная в сертификате TLS/SSL, предоставленном целевым сервером

Стандартное название TargetEndpoint. Это имеет смысл, только если TargetEndpoint относится к конечной точке TLS/SSL.

Адрес электронной почты сертификата TLS/SSL, предоставленного целевым сервером.

Ожидаемое общее название TargetEndpoint. Это имеет смысл, только если TargetEndpoint относится к конечной точке TLS/SSL.

Доменное имя целевого сервиса, возвращающего ответ прокси-серверу API.

IP-адрес целевого сервиса, возвращающего ответ прокси-серверу API.

Местоположение (город) сертификата TLS/SSL, предоставленного целевым сервером

Цель, в которую сообщение поступает из целевой конечной точки.

Организация, указанная в сертификате TLS/SSL, предоставленном целевым сервером.

Организационное подразделение сертификата TLS/SSL, предоставленного целевым сервером.

Номер порта целевого сервиса, возвращающего ответ прокси-серверу API.

Время, выраженное в виде строки, в которое TargetEndpoint завершил получение ответа от целевого сервиса. Пример: "Wed, 21 Aug 2013 19:16:47 UTC".

Это значение времени представляет собой строковое представление соответствующего 32-битного временного штампа. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению "1377112607413".

Значение временной метки, указывающее, когда TargetEndpoint завершил получение ответа от целевого сервиса. Пример: "1534783015000". Это 64-разрядное целое число, указывающее количество миллисекунд, прошедших с полуночи 1 января 1970 г. по всемирному координированному времени.

Время, выраженное в виде строки, когда TargetEndpoint начал получать ответ от целевого сервиса. Пример: "Wed, 21 Aug 2013 19:16:47 UTC".

Это значение времени представляет собой строковое представление соответствующего 32-битного временного штампа. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению "1377112607413".

Временная метка, указывающая, когда TargetEndpoint начал получать ответ от целевого сервиса. Пример: "1534783015000". Это 64-разрядное целое число, указывающее количество миллисекунд, прошедших с полуночи 1 января 1970 г. по всемирному координированному времени.

Начало области действия: целевой ответ
Тип: строка
Разрешение: чтение/запись

Возвращает http или https в зависимости от сообщения запроса.

Время, выраженное в виде строки, когда прокси-сервер перестал отправлять запрос на URL, указанный в TargetEndpoint. Пример: "Wed, 21 Aug 2013 19:16:47 UTC".

Это значение времени представляет собой строковое представление соответствующего 32-битного временного штампа. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению "1377112607413".

Временная метка, указывающая, когда прокси-сервер завершил отправку запроса по URL, указанному в TargetEndpoint. Пример: "1377112607413". Это 64-битное целое число (long), содержащее количество миллисекунд, прошедших с полуночи 1 января 1970 г. (UTC).

Время, выраженное в виде строки, в которое прокси-сервер начал отправлять запрос на URL, указанный в TargetEndpoint. Пример: "Wed, 21 Aug 2013 19:16:47 UTC".

Это значение времени представляет собой строковое представление соответствующего 32-битного временного штампа. Например, временная метка "Wed, 21 Aug 2013 19:16:47 UTC" соответствует значению "1377112607413".

Временная метка, указывающая, когда прокси-сервер начал отправлять запрос по URL, указанному в TargetEndpoint. Пример: "1534783015000". Это 64-битное целое число (long), указывающее количество миллисекунд, прошедших с полуночи 1 января 1970 г. (UTC).

Указывает, работает ли TargetEndpoint по протоколу TLS/SSL.

Статус сертификата TLS/SSL, предоставленного целевым сервером.

URL, настроенный в XML-файле TargetEndpoint, или динамический целевой URL (если target.url задан во время потока сообщений). Переменная не содержит дополнительных элементов пути или параметров запроса. Возвращает нулевое значение, если вызывается вне области действия или не задано.

Переменная, доступная для общего названия, если оно работает по протоколу TLS/SSL.

Псевдонимы хоста виртуального хоста, который был задействован при определенном запросе.

Название виртуального хоста, который обслуживает исходный запрос клиента.

Возвращает значение "true", если в конфигурации виртуального хоста включен TLS/SSL.