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

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

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

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

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

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

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

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

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

Возвращает 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 на "язык: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 proxy. Публичный URL API proxy состоит из имени вашей организации, среды, в которой развернут proxy, basepath, суффикса basepath и любых параметров запроса.

Например, в запросе к 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 proxy proxy <BasePath> в ProxyEndpoint (в дополнение к базовому URL proxy) сопоставляется с 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=Чувак"

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

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

• Запрос: нет данных
• Ответ: "http://example.com/user?user=Чувак"

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 proxy TargetEndpoint для выполнения.

Имя TargetEndpoint, которая была выполнена. Например, "default".

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

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

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

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

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.

Когда «истина», запрос, направленный из 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, представленного целевым сервером.

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

Номер порта целевой службы возвращает ответ на прокси API.

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

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

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

Время, выраженное в строковой форме, в которой TargetendPoint начал получать ответ от цели. Например, «Ср, 21 августа 2013 г. 19:16:47 UTC».

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

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

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

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

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

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

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

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

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

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

Будет ли TargetendPoint работает на TLS/SSL.

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

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

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

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

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

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