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

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

Укажите этап процесса, на котором произошла ошибка.

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

Флаг ошибки.

Список неработающих целевых серверов во время балансировки нагрузки на целевой конечной точке.

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

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

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

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

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

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

Подсчет значений указанных параметров формы в сообщении.

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

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

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

Получает или задает значение указанного 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 to "siteid:1"
• message.queryparam.type.2 to "language:en-us"
• message.queryparam.type.3 to "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 с ошибками.

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

Значение параметра Base Path в конфигурации вашего 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, включая все присутствующие параметры запроса. Хост 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 запроса, отправленного клиентским приложением.

Например, "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 будет равно "hello".

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

• request.queryparam.type.1 to "siteid:1"
• request.queryparam.type.2 to "language:en-us"
• request.queryparam.type.3 to "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". Правило маршрутизации ссылается на целевой объект API-прокси для выполнения.

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

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

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

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

URI целевой точки (TargetEndpoint) для политики ServiceCallout . URI представляет собой URL целевой точки без указания протокола и домена.

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

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

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

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

When "true", request forwarded from ProxyEndpoint to TargetEndpoint retains query parameters.

Country of the TLS/SSL certificate presented by the target server

The Common Name of the TargetEndpoint. This is meaningful only when the TargetEndpoint refers to a TLS/SSL endpoint.

Email address of the TLS/SSL certificate presented by the target server

The expected Common Name of the TargetEndpoint. This is meaningful only when the TargetEndpoint refers to a TLS/SSL endpoint.

The domain name of the target service returning the response to the API proxy.

The IP address of the target service returning the response to the API proxy.

Locality (city) of the TLS/SSL certificate presented by the target server

Target to which message is reaching from targetendpoint.

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

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
Type : String
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.