Справочник по переменным потока

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

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

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

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

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

Населенный пункт (город) в сертификате TLS/SSL, предоставленном клиентом.

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

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

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

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

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

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

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

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

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

Время, выраженное строкой, когда прокси-сервер завершил отправку ответа от ProxyEndpoint клиенту. Например: «Ср, 21 авг. 2013 г., 19:16:47 UTC».

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

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

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

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

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

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

Фраза-причина, связанная с ошибкой. Например: «Неверный запрос».

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

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

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

Флаг ошибки.

Список неисправных TargetServers во время балансировки нагрузки в TargetEndpoint.

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

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

Контекстный объект с тем же значением, что и request в потоке запросов, или как response в потоке ответов, или как 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-адресе без учета параметров запроса.

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

Значение N-го параметра запроса в сообщении. Например, если 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-подтверждения. Это может быть вызывающий клиент или балансировщик нагрузки.

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

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

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

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

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

Пример создания URL-адреса request с использованием исходного хоста см. в разделе Сообщения запроса доступа .

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

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

Указывает, была ли выполнена политика неверно (истина или ложь).

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

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

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

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

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

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

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

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

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

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

Например, «имя=тест&тип=первый&группа=А».

Возвращает или задаёт значение определённого заголовка, найденного в запросе. Если заголовок содержит запятую, при чтении будет получен только фрагмент текста до первой запятой.

Если вам нужен весь заголовок, используйте форму 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».

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

Значение N-го параметра запроса в запросе.

Например, если 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

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

• Запрос: 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 ссылается на конечную точку прокси-сервера API для выполнения.

Имя выполненной целевой конечной точки (TargetEndpoint). Например, «default».

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

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

URL-адрес TargetEndpoint для конкретной политики ServiceCallout .

URI TargetEndpoint для политики ServiceCallout . URI — это URL-адрес TargetEndpoint без указания протокола и домена.

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

Имя модуля, на котором работает прокси.

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

Время чтения этой переменной. Например, «Ср, 21 авг. 2013 г., 19:16:47 UTC».

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

Часть года в system.time .

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

Часть дня месяца в system.time .

Часть дня недели в system.time .

Часовая часть system.time .

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

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

Миллисекундная часть system.time .

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

64-битное (длинное) целое число, представляющее время чтения этой переменной. Значение — это количество миллисекунд, прошедших с полуночи 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, предоставленного целевым сервером

Цель, к которой сообщение достигает targetendpoint.

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

Organization unit of the TLS/SSL certificate presented by the target server.

The port number of the target service returning the response to the API proxy.

The time, expressed in string form, at which the TargetEndpoint finished receiving the response from the target. For example, "Wed, 21 Aug 2013 19:16:47 UTC".

This time value is the string representation of the corresponding 32-bit timestamp quantity. For example, "Wed, 21 Aug 2013 19:16:47 UTC" corresponds to the timestamp value of "1377112607413"..

The timestamp value specifying when the TargetEndpoint finished receiving the response from the target. For example, "1534783015000". This value is a 64-bit (long) integer specifying the number of milliseconds elapsed since midnight, on January 1, 1970 UTC.

The time, expressed in string form, at which the TargetEndpoint started receiving the response from the target. For example, "Wed, 21 Aug 2013 19:16:47 UTC".

This time value is the string representation of the corresponding 32-bit timestamp quantity. For example, "Wed, 21 Aug 2013 19:16:47 UTC" corresponds to the timestamp value of "1377112607413".

The timestamp value specifying when the TargetEndpoint started receiving the response from the target. For example, "1534783015000". This value is a 64-bit (long) integer specifying the number of milliseconds elapsed since midnight, on January 1, 1970 UTC.

Scope begins : Target response
Тип : Строка
Permission : Read/Write

Returns http or https depending on the request message.

The time, expressed in string form, at which the proxy stopped sending the request to the URL specified in the TargetEndpoint. For example, "Wed, 21 Aug 2013 19:16:47 UTC".

This time value is the string representation of the corresponding 32-bit timestamp quantity. For example, "Wed, 21 Aug 2013 19:16:47 UTC" corresponds to the timestamp value of "1377112607413".

The timestamp value specifying when the proxy finished sending the request to the URL specified in the TargetEndpoint. For example, "1377112607413". This value is a 64-bit (long) integer containing the number of milliseconds elapsed since midnight, on January 1, 1970 UTC.

The time, expressed in string form, at which the proxy began sending the request to the URL specified in the TargetEndpoint. For example, "Wed, 21 Aug 2013 19:16:47 UTC".

This time value is the string representation of the corresponding 32-bit timestamp quantity. For example, "Wed, 21 Aug 2013 19:16:47 UTC" corresponds to the timestamp value of "1377112607413".

The timestamp value specifying when the proxy started sending the request to the URL specified in the TargetEndpoint. For example, "1534783015000". This value is a 64-bit (long) integer specifying the number of milliseconds elapsed since midnight, on January 1, 1970 UTC.

Whether TargetEndpoint is running on TLS/SSL.

State of the TLS/SSL certificate presented by the target server.

The URL configured in the TargetEndpoint XML file or the dynamic target URL (if target.url is set during the message flow). The variable does not include any additional path elements or query parameters. Returns null if called out of scope or otherwise unset.

Variable exposed for the common name if it's running on TLS/SSL.

Host aliases of the virtual host that is hit during a particular request.

Name of the virtual host that serves the originating client request.

Returns "true" if TLS/SSL is enabled in the virtual host configuration.