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

Общее имя, указанное в сертификате 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.

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

Состояние сертификата 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 будет «привет».

В качестве примера записи нескольких значений для одного имени параметра запроса, например «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 в «валюта: доллар США»

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

Например, если строка запроса — 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.

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

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

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

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

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

Получает или задает полезные данные сообщения запроса.

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

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

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

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

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

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

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

• request.queryparam.type.1 на «siteid:1»
• request.queryparam.type.2 на «язык: en-us»
• request.queryparam.type.3 в «валюта: доллар США»

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

Например, если 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=Чувак"
• Ответ: 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-глагол, используемый для запроса. Например, «ПОЛУЧИТЬ», «ПОСТАВИТЬ» и «УДАЛИТЬ».

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. Например, «по умолчанию». RouteRule ссылается на прокси-сервер API TargetEndpoint для выполнения.

Имя выполненной TargetEndpoint. Например, «по умолчанию».

Устарело и возвращает ноль. (Ранее 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 года по всемирному координированному времени. Например, «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 будет нулевым.

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

Если установлено значение «истина», запрос, пересылаемый из 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 закончила получение ответа от цели. Например, «Ср, 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 включен в конфигурацию виртуального хоста.