Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Ta sekcja zawiera informacje referencyjne na temat zmiennych przepływu.
Apigee Edge definiuje te zmienne przepływu:
apigee
loadbalancing
router
apiproxy
message
servicecallout
application
messageid
system
client
organization
target
current
proxy
variable
environment
request
virtualhost
error
response
is
route
Każda z tych zmiennych jest opisana w dalszej części tego artykułu.
apigee
Zmienna pomocnicza, która udostępnia informacje o czasie wykonywania zasady.
W tabeli poniżej opisano właściwości zmiennej apigee
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
apigee.metrics.policy.policy_name.timeTaken |
Liczba całkowita | Tylko do odczytu | Czas wykonania zasady (w nanosekundach). | Zasady |
apiproxy
Opisuje serwer proxy interfejsu API.
W tabeli poniżej opisano właściwości zmiennej apiproxy
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
apiproxy.name |
Ciąg znaków | Tylko do odczytu | Nazwa serwera proxy interfejsu API. Na przykład „Mój serwer proxy”. | Żądanie do serwera proxy |
apiproxy.revision |
Ciąg znaków | Tylko do odczytu | Numer wersji serwera proxy interfejsu API. np. „6”. | Żądanie do serwera proxy |
Więcej informacji o pracy z serwerami proxy interfejsu API znajdziesz w artykule Omówienie interfejsów API Proxy interfejsów API.
application
Kontener właściwości application.basepath
.
W tabeli poniżej opisano właściwości zmiennej application
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
application.basepath |
Ciąg znaków | Tylko do odczytu | Ścieżka podstawowa wdrożenia (określana podczas wdrażania interfejsu API). | Żądanie do serwera proxy |
client
Aplikacja lub system, który wysłał żądanie do routera brzegowego.
W tabeli poniżej opisano właściwości zmiennej client
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
client.cn |
Ciąg znaków | Tylko do odczytu |
Nazwa powszechna określona w certyfikacie TLS/SSL przedstawianym przez aplikację kliencką. |
Żądanie do serwera proxy |
client.country |
Ciąg znaków | Tylko do odczytu |
Kraj w certyfikacie TLS/SSL przedstawianym przez aplikację kliencką. |
Żądanie do serwera proxy |
client.email.address |
Ciąg znaków | Tylko do odczytu |
Adres e-mail w certyfikacie TLS/SSL prezentowany przez aplikację kliencką. |
Żądanie do serwera proxy |
client.host |
Ciąg znaków | Tylko do odczytu |
Adres IP hosta HTTP powiązany z żądaniem otrzymanym przez punkt końcowy serwera proxy. |
Żądanie do serwera proxy |
client.ip |
Ciąg znaków | Tylko do odczytu |
Adres IP klienta lub systemu wysyłającego wiadomość do routera brzegowego. Dla: może to być na przykład pierwotny adres IP klienta lub adres IP systemu równoważenia obciążenia. |
Żądanie do serwera proxy |
client.locality |
Ciąg znaków | Tylko do odczytu |
Miejscowość (miasto) w certyfikacie TLS/SSL przedstawianym przez klienta. |
Żądanie do serwera proxy |
client.organization |
Ciąg znaków | Tylko do odczytu | Organizacja objęta certyfikatem TLS/SSL podane przez klienta. Nie musi to być odpowiednik organizacji w Apigee Edge. | Żądanie do serwera proxy |
client.organization.unit |
Ciąg znaków | Tylko do odczytu |
Jednostka organizacyjna w certyfikacie TLS/SSL przedstawiony przez klienta. |
Żądanie do serwera proxy |
client.port |
Liczba całkowita | Tylko do odczytu |
Port HTTP powiązany ze źródłowym żądaniem klienta do punktu końcowego ProxyEndpoint. |
Żądanie do serwera proxy |
client.received.end.time |
Ciąg znaków | Tylko do odczytu |
Czas w postaci ciągu znaków, o którym serwer proxy zakończył odebranie żądania. ze źródłowego klienta w punkcie końcowym ProxyEndpoint. Na przykład: Wed, 21 Aug 2013 19:16:47 (czas UTC) Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową sygnaturę czasową ilość. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej 1377112607413. |
Żądanie do serwera proxy |
client.received.end.timestamp |
Długi | Tylko do odczytu |
Wartość sygnatury czasowej, która określa, kiedy serwer proxy otrzymał żądanie z klient źródłowy w ProxyEndpoint. Ta wartość jest 64-bitową (długą) liczbą całkowitą zawierającą liczba milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. |
Żądanie do serwera proxy |
client.received.start.time |
Ciąg znaków | Tylko do odczytu |
Godzina, wyrażona w postaci ciągu znaków, od której serwer proxy zaczął otrzymywać żądanie ze źródłowego klienta w punkcie końcowym ProxyEndpoint. Na przykład: Wed, 21 Aug 2013 19:16:47 (czas UTC) Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową sygnaturę czasową ilość. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej 1377112607413. |
Żądanie do serwera proxy |
client.received.start.timestamp |
Długi | Tylko do odczytu |
Wartość sygnatury czasowej, która określa, kiedy serwer proxy zaczął otrzymywać żądanie z klient źródłowy w ProxyEndpoint. Ta wartość jest 64-bitową (długą) liczbą całkowitą zawierającą liczba milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. |
Żądanie do serwera proxy |
client.scheme |
Ciąg znaków | Tylko do odczytu |
Zwraca http lub https w zależności od transportu używanego przez aplikację kliencką do wysyłania z prośbą o połączenie. |
Żądanie do serwera proxy |
client.sent.end.time |
Ciąg znaków | Tylko do odczytu |
Godzina, w postaci ciągu znaków, o której serwer proxy zakończył wysyłanie odpowiedzi z ProxyEndpoint do klienta. Na przykład: „Wed, 21 Aug 2013 19:16:47 UTC”. Ta wartość jest ciągiem znaków reprezentującym odpowiednie 32-bitowe wartości
|
PostClientFlow |
client.sent.end.timestamp |
Długi | Tylko do odczytu | Wartość sygnatury czasowej określająca, kiedy punkt końcowy serwera proxy zakończył zwracanie odpowiedzi do źródłowej aplikacji klienckiej. Ta wartość jest 64-bitową (długą) liczbą całkowitą zawierającą liczba milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. | PostClientFlow |
client.sent.start.time |
Ciąg znaków | Tylko do odczytu | Wyrażony w postaci ciągu znaków czas, kiedy punkt końcowy serwera proxy zaczął zwracać
na adres URL źródłowej aplikacji klienckiej. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC”.
Ta wartość jest ciągiem znaków reprezentującym odpowiednie 32-bitowe wartości
|
PostClientFlow |
client.sent.start.timestamp |
Długi | Tylko do odczytu | Kiedy serwer proxy zaczął wysyłać odpowiedź do klienta z punktu ProxyEndpoint. Ten jest wyrażona jako 64-bitowa (długa) liczba całkowita zawierająca liczbę milisekund upłynęło od północy, 1 stycznia 1970 r. czasu UTC. | PostClientFlow |
client.ssl.enabled |
Ciąg znaków | Tylko do odczytu |
„true” jeśli punkt końcowy serwera proxy jest skonfigurowany pod kątem protokołu TLS/SSL; w przeciwnym razie ma wartość „false” (fałsz). |
Żądanie do serwera proxy |
client.state |
Ciąg znaków | Tylko do odczytu |
Stan w certyfikacie TLS/SSL przedstawianym przez klienta. |
Żądanie do serwera proxy |
current
Zawiera informacje o bieżącym przepływie serwera proxy interfejsu API.
W tabeli poniżej opisano właściwości zmiennej current
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
current.flow.name |
Ciąg znaków | Tylko do odczytu | Nazwa obecnie wykonywanego przepływu (na przykład „PreFlow”, „PostFlow” lub nazwę przepływu warunkowego). | Żądanie do serwera proxy |
current.flow.description |
Ciąg znaków | Tylko do odczytu | Opis aktualnie wykonywanego przepływu. Jest taka sama jak
wartości elementu <Description> w konfiguracji XML przepływu. |
Żądanie do serwera proxy |
Te właściwości możesz wyświetlić w widoku śledzenia w interfejsie Edge. Właściwości te nie są jednak widoczne domyślnie w widoku logu czasu klasycznego interfejsu użytkownika.
environment
Kontener właściwości environment.name
.
W tabeli poniżej opisano właściwości zmiennej environment
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
environment.name |
Ciąg znaków | Tylko do odczytu | Nazwa środowiska, w którym realizowano transakcję. | Żądanie do serwera proxy |
error
Obiekt kontekstowy, który reprezentuje komunikat o błędzie w tagu procedurę błędów.
W tabeli poniżej opisano właściwości zmiennej error
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
error |
message |
Odczyt/zapis | Błąd typu message , który jest obiektem kontekstowym w procesie błędu. |
Błąd |
error.content |
Ciąg znaków | Odczyt/zapis | Treść błędu. | Błąd |
error.message |
Ciąg znaków | Tylko do odczytu |
Komunikat powiązany z błędem, którego wartość jest dostępna wyłącznie przed wystąpieniem błędu . |
Błąd |
error.status.code |
Liczba całkowita | Tylko do odczytu |
Kod stanu HTTP powiązany z błędem. Przykład: „400”. |
Błąd |
error.reason.phrase |
Ciąg znaków | Tylko do odczytu |
Wyrażenie określające przyczynę błędu. Na przykład: „Nieprawidłowe żądanie”. |
Błąd |
error.transport.message |
TransportMessage | Tylko do odczytu |
Dowolny błąd typu TransportMessage. |
Błąd |
error.state |
Liczba całkowita | Tylko do odczytu |
Stan przepływu danych, w którym wystąpił błąd. |
Błąd |
error.header.header_name |
Ciąg znaków | Odczyt/zapis |
Pobierz lub ustaw nagłówek odpowiedzi. |
Błąd |
fault
Zmienna przepływu, która jest ustawiona na kod błędu w czasie działania, gdy zasada zgłasza błąd. Wartości kodu błędu są inne dla każdej zasady.
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
fault.fault_name |
Ciąg znaków | Tylko do odczytu | fault_name to nazwa błędu podana w tabeli Błędy działania dostępne w każdym temacie odwołań do zasad. | Błąd |
is
Kontener właściwości is.error
.
W tabeli poniżej opisano właściwości zmiennej is
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
is.error |
Wartość logiczna | Tylko do odczytu |
Flaga błędu. |
Żądanie do serwera proxy |
loadbalancing
Udostępnia informacje o stanie równoważenia obciążenia w docelowym punkcie końcowym.
W tabeli poniżej opisano właściwości zmiennej loadbalancing
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
loadbalancing.failedservers |
Tablica ciągów znaków | Tylko do odczytu |
Lista serwerów docelowych, których nie udało się wczytać podczas równoważenia obciążenia w punkcie końcowym TargetEndpoint. |
Odpowiedź docelowa |
loadbalancing.isfallback |
Wartość logiczna | Tylko do odczytu |
„true” jeśli włączona jest funkcja awaryjnego serwera docelowego wywoływanego podczas równoważenia obciążenia w TargetEndpoint. |
Odpowiedź docelowa |
loadbalancing.targetserver |
Ciąg znaków | Tylko do odczytu |
Serwer docelowy został wywołany podczas równoważenia obciążenia w docelowym punkcie końcowym. Ustaw tylko wtedy, gdy parametr
Podczas definiowania elementu systemu równoważenia obciążenia ustawiono element |
Odpowiedź docelowa |
message
Obiekt kontekstowy o tej samej wartości co request
w przepływie żądania.
lub jako response
w procesie odpowiedzi lub jako error
w błędzie
przepływu danych.
W tabeli poniżej opisano właściwości zmiennej message
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
message |
message |
Odczyt/zapis |
Obiekt kontekstowy o tej samej wartości co |
Żądanie do serwera proxy |
message.content |
Ciąg znaków | Odczyt/zapis |
Treść żądania, odpowiedzi lub komunikatu o błędzie. |
Żądanie do serwera proxy |
message.formparam.param_name |
Ciąg znaków | Odczyt/zapis |
Wartość określonego parametru formularza. |
Żądanie do serwera proxy |
message.formparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego parametru formularza w wiadomości. |
Żądanie do serwera proxy |
message.formparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wartości określonych parametrów formularza w wiadomości. |
Żądanie do serwera proxy |
message.formparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich parametrów formularza w wiadomości. |
Żądanie do serwera proxy |
message.formparams.names |
Kolekcja | Tylko do odczytu |
Wartość wszystkich parametrów formularza w wiadomości. |
Żądanie do serwera proxy |
message.formstring |
Ciąg znaków | Tylko do odczytu |
Wartość ciągu tekstowego formularza w wiadomości. |
Żądanie do serwera proxy |
message.header.header_name |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia wartość określonego nagłówka HTTP w wiadomości. Jeśli nagłówek
zawiera przecinek, po przeczytaniu otrzymasz tylko segment tekstu do pierwszej
przecinek. Jeśli chcesz otrzymać cały nagłówek, użyj formularza
|
Żądanie do serwera proxy |
message.header.header_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tej konkretnej wartości nagłówka w wiadomości, np. żądanie lub w zależności od stanu przepływu. Apigee Edge dzieli wartości tekstu nagłówka według przecinków. Pamiętaj, że indeks, którego wartość jest używana w przypadku N, jest od 1 , a nie od 0. Jeśli na przykład nagłówek |
Żądanie do serwera proxy |
message.header.header_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonej nazwy nagłówka HTTP w wiadomości. |
Żądanie do serwera proxy |
message.header.header_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wartości określonej nazwy nagłówka HTTP w wiadomości. |
Żądanie do serwera proxy |
message.headers.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich nagłówków HTTP w wiadomości. |
Żądanie do serwera proxy |
message.headers.names |
Kolekcja | Tylko do odczytu |
Wartość wszystkich nagłówków HTTP w wiadomości |
Żądanie do serwera proxy |
message.path |
Ciąg znaków | Odczyt/zapis |
Pełna ścieżka wiadomości z żądaniem w adresie URL bez żadnych parametrów zapytania. |
Żądanie do serwera proxy |
message.queryparam.param_name |
Ciąg znaków | Tylko do odczytu |
Zwraca określony parametr zapytania o wiadomości. |
Żądanie do serwera proxy |
message.queryparam.param_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tego parametru zapytania w wiadomości. Na przykład, jeśli plik
Oto przykład zapisywania wielu wartości dla jednej nazwy parametru zapytania, jak "type=siteid:1&type=language:pl-pl&type=currency:USD" ustaw następujące ustawienia:
|
Żądanie do serwera proxy |
message.queryparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego parametru zapytania w wiadomości w formacie rozdzielane przecinkami. Jeśli na przykład ciąg zapytania to |
Żądanie do serwera proxy |
message.queryparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Łączna liczba określonego parametru zapytania powiązanego z żądaniem wysłanym do funkcji ProxyEndpoint z aplikacji klienckiej. |
Żądanie do serwera proxy |
message.queryparams.count |
Liczba całkowita | Tylko do odczytu |
Łączna liczba wszystkich parametrów zapytania powiązanych z żądaniem wysłanym do ProxyEndpoint z aplikacji klienckiej. |
Żądanie do serwera proxy |
message.queryparams.names |
Kolekcja | Tylko do odczytu |
Lista wszystkich nazw parametrów zapytania powiązanych z żądaniem wysłanym do funkcji ProxyEndpoint z aplikacji klienckiej. Aby wykonać iterację nazw parametrów zapytania za pomocą JavaScriptu, zapoznaj się z poniższym opisem Apigee Post na karcie Społeczność: Jak iterować kolekcję z „request.queryparams.names” w JS? w społeczności Apigee. |
Żądanie do serwera proxy |
message.querystring |
Ciąg znaków | Tylko do odczytu |
Ciąg znaków zawierający wszystkie nazwy i wartości parametrów zapytania powiązane z żądaniem wysyłane do punktu końcowego serwera proxy z aplikacji klienckiej. Na przykład dla żądania „http://api.apifactory.com/inventors?name=nick&surname=danger”
wartość |
Żądanie do serwera proxy |
message.reason.phrase |
Ciąg znaków | Tylko do odczytu |
PrzyczynaWyrażenie w wiadomości z odpowiedzią od elementu docelowego. |
Odpowiedź docelowa |
message.status.code |
Liczba całkowita | Tylko do odczytu |
Kod stanu HTTP komunikatu odpowiedzi z serwera docelowego. |
Odpowiedź docelowa |
message.transport.message |
TransportMessage | Tylko do odczytu |
Komunikat typu TransportMessage, który jest obiektem kontekstowym. |
Żądanie do serwera proxy |
message.uri |
Ciąg znaków | Tylko do odczytu |
Pełna ścieżka identyfikatora URI (po adresie URL domeny) wraz z parametrami zapytania. Na przykład dla żądania „http://api.apifactory.com/inventors?name=nikola&surname=tesla” ta zmienna zwraca „inventors?name=nikola&surname=tesla”. |
Żądanie do serwera proxy |
message.verb |
Ciąg znaków | Tylko do odczytu |
Czasownik HTTP ( |
Żądanie do serwera proxy |
message.version |
Ciąg znaków | Odczyt/zapis |
Wersja HTTP powiązana z żądaniem wysłanym do punktu ProxyEndpoint z klienta aplikacji. |
Żądanie do serwera proxy |
Więcej informacji o wiadomościach: Odniesienie do funkcji szablonu wiadomości.
messageid
Kontener globalnego unikalnego identyfikatora żądania.
W tabeli poniżej opisano właściwości zmiennej messageid
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
messageid |
Ciąg znaków | Tylko do odczytu |
Zawiera globalny, unikalny identyfikator żądania, w tym nazwę hosta routera. Ten identyfikator umożliwia śledzenie żądań otrzymanych na routerze po ich wysłaniu do procesor wiadomości. Ten identyfikator jest logowany w logach błędów Edge, aby skorelować identyfikator |
Żądanie do serwera proxy |
organization
Kontener właściwości organization.name
.
W tabeli poniżej opisano właściwości zmiennej organization
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
organization.name |
Ciąg znaków | Tylko do odczytu |
Nazwa organizacji. |
Żądanie do serwera proxy |
Więcej informacji o organizacjach znajdziesz tutaj: Zrozumienie .
proxy
Konfiguracja serwera proxy interfejsu API.
W tabeli poniżej opisano właściwości zmiennej proxy
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
proxy.basepath |
Ciąg znaków | Tylko do odczytu |
Wartość ścieżki podstawowej w konfiguracji serwera proxy interfejsu API. Ścieżka podstawowa to identyfikator URI który następuje po hoście w adresie URL. Identyfikatory URI przepływu warunkowego są zgodne z podstawą ścieżki konwersji. W adresie URL „http://myorg-test.apigee.net/v2/Weatherapi/forecastrss?w=12797282”:
Jedyny sposób, w jaki to wiesz, jest sprawdzenie definicji serwera proxy interfejsu API lub sprawdzenie wartości w rekordzie proxy.basepath . Sufiks ścieżki serwera proxy znajduje się za ścieżką podstawową („/forecastrss”) wraz ze wszystkimi parametrów zapytania. Jeśli zdefiniujesz dynamiczną ścieżkę podstawową na serwerze proxy interfejsu API konfiguracji, np. „/v2/*/Weatherapi”, ta zmienna jest ustawiona na ścieżkę dynamiczną („/v2/*/Weatherapi”), nawet jeśli ścieżka podstawowa przyjmuje wartość statyczną, np. "/v2/foo/weatherapi". |
Żądanie do serwera proxy |
proxy.client.ip |
Ciąg znaków | Tylko do odczytu |
Adres |
Żądanie do serwera proxy |
proxy.name |
Ciąg znaków | Tylko do odczytu |
Atrybut nazwy skonfigurowany dla ProxyEndpoint. |
Żądanie do serwera proxy |
proxy.pathsuffix |
Ciąg znaków | Tylko do odczytu |
Wartość sufiksu ścieżki bazowej serwera proxy interfejsu API, który jest wysyłany z klienta i odebrany ProxyEndpoint. Ścieżka bazowa to komponent ścieżki, który jednoznacznie identyfikuje serwer proxy interfejsu API. Widoczny adres URL serwera proxy interfejsu API składa się z nazwy organizacji, środowisko, w którym jest wdrożony serwer proxy, ścieżka bazowa, sufiks ścieżki podstawowej i dowolne zapytanie. . Na przykład w żądaniu wysłanym do |
Żądanie do serwera proxy |
proxy.url |
Ciąg znaków | Tylko do odczytu |
Pobiera pełny adres URL powiązany z żądaniem serwera proxy odebranym przez punkt końcowy serwera proxy,
łącznie z żadnymi parametrami zapytania.
Hostem adresu URL będzie zawsze Przykład tworzenia adresu URL w elemencie |
Żądanie do serwera proxy |
Więcej informacji o pracy z serwerami proxy interfejsu API znajdziesz w artykule Omówienie interfejsów API Proxy interfejsów API.
request
Kompletne żądanie, w tym dowolny ładunek.
Więcej informacji na temat danych dotyczących żądań znajdziesz tutaj: W jaki sposób dane żądania są przekazywane do serwera backendu?
W tabeli poniżej opisano właściwości zmiennej request
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
request |
message |
Tylko do odczytu |
Kompletne żądanie, w tym dowolny ładunek. |
Żądanie do serwera proxy |
request.content |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia ładunek komunikatu z żądania. |
Żądanie do serwera proxy |
request.formparam.param_name |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia wartość określonego parametru formularza w żądaniu wysłanym z do aplikacji klienckiej. |
Żądanie do serwera proxy |
request.formparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego parametru formularza w żądaniu, w formacie rozdzielane przecinkami. Jeśli na przykład ładunek to
"a=hello&x=welcome&a=world", to wartość
|
Żądanie do serwera proxy |
request.formparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego parametru formularza powiązanego z żądaniem. |
Żądanie do serwera proxy |
request.formparam.param_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tego określonego parametru formularza w wiadomości. Na przykład, jeśli
ciąg formularza to „a=hello&a=world”, a następnie zwracana jest wartość
|
Żądanie do serwera proxy |
request.formparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich parametrów formularza powiązanych z żądaniem wysłanym od klienta aplikacji. |
Żądanie do serwera proxy |
request.formparams.names |
Kolekcja | Tylko do odczytu |
Lista wszystkich nazw parametrów formularza powiązanych z żądaniem. |
Żądanie do serwera proxy |
request.formstring |
Ciąg znaków | Tylko do odczytu |
Pełne pole Na przykład „name=test&type=first&group=A”. |
Żądanie do serwera proxy |
request.header.header_name |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia wartość określonego nagłówka znalezionego w żądaniu. Jeśli nagłówek zawiera przecinek, po przeczytaniu otrzymasz tylko segment tekstu do pierwszej przecinek. Jeśli chcesz otrzymać cały nagłówek, użyj formularza
|
Żądanie do serwera proxy |
request.header.header_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tej konkretnej wartości nagłówka w żądaniu. Apigee Edge rozdziela wartości w tekście nagłówków przecinkami. Zauważ, że indeks, którego wartość jest używana jako N, to od 1, a nie od 0. Jeśli np. nagłówek |
Żądanie do serwera proxy |
request.header.header_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego nagłówka w żądaniu. |
Żądanie do serwera proxy |
request.header.header_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego nagłówka w żądaniu. |
Żądanie do serwera proxy |
request.headers.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich nagłówków w żądaniu. |
Żądanie do serwera proxy |
request.headers.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich nagłówków w żądaniu. |
Żądanie do serwera proxy |
request.path |
Ciąg znaków | Tylko do odczytu |
ścieżkę zasobu bez serwera proxy (bez hosta) do usługi backendu; z wyłączeniem parametrów zapytania. Na przykład identyfikator URI usługi backendu to
„https://example.com/rest/api/latest”, to wartość zmiennej
|
Żądanie do serwera proxy |
request.queryparam.param_name |
Ciąg znaków | Odczyt/zapis |
Wartość konkretnego parametru zapytania znalezionego w żądaniu. |
Żądanie do serwera proxy |
request.queryparam.param_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tego parametru zapytania w żądaniu. Jeśli na przykład Oto przykład zapisywania wielu wartości dla jednej nazwy parametru zapytania, jak "type=siteid:1&type=language:pl-pl&type=currency:USD" ustaw następujące ustawienia:
|
Żądanie do serwera proxy |
request.queryparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego parametru zapytania w żądaniu, w formacie rozdzielane przecinkami. Jeśli na przykład |
Żądanie do serwera proxy |
request.queryparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego parametru zapytania w żądaniu. |
Żądanie do serwera proxy |
request.queryparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich parametrów zapytania w żądaniu. |
Żądanie do serwera proxy |
request.queryparams.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich parametrów zapytania w żądaniu. Aby sprawdzić nazwy parametrów zapytania za pomocą JavaScriptu, zapoznaj się z artykułem Jak iterować kolekcję na podstawie „request.queryparams.names” w JS? Społeczność Apigee. |
Żądanie do serwera proxy |
request.querystring |
Ciąg znaków | Tylko do odczytu |
Pełna lista parametrów zapytania w żądaniu wysłanym z aplikacji klienckiej. Jeśli na przykład żądanie to „http://host.com/123?name=first&surname=second&place=address”, , ta zmienna zwróci wartość „name=first&surname=second&place=address”. |
Żądanie do serwera proxy |
request.transportid |
Ciąg znaków | Tylko do odczytu |
Identyfikator żądania w formie TransportMessage, który jest obiektem kontekstowym. |
Żądanie do serwera proxy |
request.transport.message |
Transport-Wiadomość | Tylko do odczytu |
Żądanie typu TransportMessage, które jest obiektem ciągłym. |
Żądanie do serwera proxy |
request.uri |
Ciąg znaków | Tylko do odczytu |
Na serwerze proxy interfejsu API serwer proxy
Wskazuje na
W żądaniu W odpowiedzi Różnica polega na tym, że pierwotne żądanie dotarło do serwera proxy, a potem do niego dotarły wysyła kolejne żądanie do usługi docelowej. Załóżmy, że poniższe wywołanie jest wysyłane do naszego przykładowego serwera proxy, który ma ścieżkę podstawową z "/my-mock-proxy":
Serwer proxy wywołuje:
Co powoduje dołączenie ciągu "/user?user=Dude" do tego adresu URL.
|
Żądanie serwera proxy (różni się w odpowiedzi) |
request.url |
Ciąg znaków | Tylko do odczytu |
Pełny adres URL żądania wysłanego do docelowego punktu końcowego, w tym parametrów ciągu zapytania, bez numeru portu (jeśli został podany). Jeśli na przykład wywołujesz przykładowy serwer proxy, „http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude” i docelowy punkt końcowy to „http://example.com:8080”, wartość ma postać:
|
Odpowiedź docelowa |
request.verb |
Ciąg znaków | Tylko do odczytu |
Czasownik HTTP użyty w żądaniu. Na przykład „GET”, „PUT” i „DELETE”. |
Żądanie do serwera proxy |
request.version |
Ciąg znaków | Tylko do odczytu |
Wersja HTTP żądania. Przykład: „1.1”. |
Żądanie do serwera proxy |
response
Pełna odpowiedź z uwzględnieniem ładunku.
W tabeli poniżej opisano właściwości zmiennej response
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
response |
message |
Odczyt/zapis |
Pełna odpowiedź zwrócona przez element docelowy. |
Odpowiedź docelowa |
response.content |
Ciąg znaków | Odczyt/zapis |
Ładunek treści wiadomości odpowiedzi zwróconej przez element docelowy. |
Odpowiedź docelowa |
response.formparam.param_name |
Ciąg znaków | Odczyt/zapis |
Wartość parametru formularza w odpowiedzi. |
Odpowiedź docelowa |
response.formparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego parametru formularza w odpowiedzi. |
Odpowiedź docelowa |
response.formparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich prametrów w postaci w odpowiedzi. |
Odpowiedź docelowa |
response.formparams.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich parametrów formularza w odpowiedzi. |
Odpowiedź docelowa |
response.header.header_name |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia wartość określonego nagłówka HTTP w odpowiedzi. Jeśli tekst nagłówka zawiera przecinek, Apigee Edge ustala wiele wartości. W tym przypadku
Aby odczytać cały nagłówek, użyj formularza |
Odpowiedź docelowa |
response.header.header_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego nagłówka HTTP w odpowiedzi. |
Odpowiedź docelowa |
response.header.header_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego nagłówka HTTP w odpowiedzi. |
Odpowiedź docelowa |
response.header.header_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tej konkretnej wartości nagłówka w odpowiedzi. Apigee Edge rozdziela wartości w tekście nagłówków przecinkami. Zauważ, że indeks, którego wartość jest używana jako N, to od 1, a nie od 0. Jeśli na przykład nagłówek |
Odpowiedź docelowa |
response.headers.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich nagłówków w odpowiedzi. |
Odpowiedź docelowa |
response.headers.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich nagłówków w odpowiedzi. |
Odpowiedź docelowa |
response.reason.phrase |
Ciąg znaków | Odczyt/zapis |
Wyrażenie uzasadnienia odpowiedzi na konkretne żądanie. |
Odpowiedź docelowa |
response.status.code |
Liczba całkowita | Odczyt/zapis |
Kod odpowiedzi zwrócony na żądanie. Za pomocą tej zmiennej możesz zastąpić
kodu stanu odpowiedzi, który jest przechowywany w |
Odpowiedź docelowa |
response.transport.message |
Ciąg znaków | Tylko do odczytu |
Odpowiedź typu TransportMessage, który jest obiektem ciągłym. |
Odpowiedź docelowa |
route
Określa nazwy punktów <RouteRule>
i docelowego punktu końcowego.
W tabeli poniżej opisano właściwości zmiennej route
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
route.name |
Ciąg znaków | Tylko do odczytu |
Nazwa obiektu |
Żądanie docelowe |
route.target |
Ciąg znaków | Tylko do odczytu |
Nazwa docelowego punktu końcowego, który został wykonany. Przykład: „default”. |
Żądanie docelowe |
router
Kontener usługi router.uuid
, która została wycofana.
W tabeli poniżej opisano właściwości zmiennej router
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
router.uuid |
Ciąg znaków | Tylko do odczytu |
Wycofano, zwraca wartość null. (Wcześniej identyfikator UUID routera obsługującego proxy.) |
Żądanie do serwera proxy |
servicecallout
Opisuje element TargetEndpoint zasady ServiceCallout.
W tabeli poniżej opisano właściwości zmiennej servicecallout
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
servicecallout.policy_name.expectedcn |
Ciąg znaków | Odczyt/zapis |
Oczekiwana wspólna nazwa punktu końcowego, o której mowa w Zasady dotyczące ServiceCallout. Ma to znaczenie tylko wtedy, gdy element docelowy punktu końcowego odnosi się do do punktu końcowego TLS/SSL. |
Żądanie do serwera proxy |
servicecallout.policy_name.target.url |
Ciąg znaków | Odczyt/zapis |
Adres URL punktu końcowego (TargetEndpoint) dla określonej zasady ServiceCallout. |
Żądanie do serwera proxy |
servicecallout.requesturi |
Ciąg znaków | Odczyt/zapis |
Identyfikator URI TargetEndpoint zasady ServiceCallout. Identyfikator URI to Adres URL docelowego punktu końcowego bez specyfikacji protokołu i domeny. |
Żądanie do serwera proxy |
system
Określa adres IP systemu i szczegóły serwera proxy.
W tabeli poniżej opisano właściwości zmiennej system
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
system.interface.interface_name |
Ciąg znaków | Tylko do odczytu |
Adres IP systemu. |
Żądanie do serwera proxy |
system.pod.name |
Ciąg znaków | Tylko do odczytu |
Nazwa poda, w którym działa serwer proxy. |
Żądanie do serwera proxy |
system.region.name |
Ciąg znaków | Tylko do odczytu |
Nazwa centrum danych region, w którym działa serwer proxy. |
Żądanie do serwera proxy |
system.time |
Ciąg znaków | Tylko do odczytu |
Czas odczytu tej zmiennej. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC”. Ta wartość jest ciągiem znaków reprezentującym odpowiednią wartość argumentu
|
Żądanie do serwera proxy |
system.time.year |
Liczba całkowita | Tylko do odczytu |
Część roku w |
Żądanie do serwera proxy |
system.time.month |
Liczba całkowita | Tylko do odczytu |
Część miesiąca |
Żądanie do serwera proxy |
system.time.day |
Liczba całkowita | Tylko do odczytu |
Część miesiąca miesiąca |
Żądanie do serwera proxy |
system.time.dayofweek |
Liczba całkowita | Tylko do odczytu |
Dzień tygodnia ( |
Żądanie do serwera proxy |
system.time.hour |
Liczba całkowita | Tylko do odczytu |
Część godzinowa zakresu |
Żądanie do serwera proxy |
system.time.minute |
Liczba całkowita | Tylko do odczytu |
Część minutowa z |
Żądanie do serwera proxy |
system.time.second |
Liczba całkowita | Tylko do odczytu |
Druga część |
Żądanie do serwera proxy |
system.time.millisecond |
Liczba całkowita | Tylko do odczytu |
Część milisekundowa zmiennej |
Żądanie do serwera proxy |
system.time.zone |
Ciąg znaków | Tylko do odczytu |
Strefa czasowa systemu. |
Żądanie do serwera proxy |
system.timestamp |
Długi | Tylko do odczytu |
64-bitowa (długa) liczba całkowita określająca czas odczytu tej zmiennej. Wartość to liczba milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. Przykład: „1534783015000”. |
Żądanie do serwera proxy |
system.uuid |
Ciąg znaków | Tylko do odczytu |
Identyfikator UUID podmiotu przetwarzającego wiadomości obsługującego serwer proxy. |
Żądanie do serwera proxy |
target
Opisuje cel żądania.
W tabeli poniżej opisano właściwości zmiennej target
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
target.basepath |
Ciąg znaków | Tylko do odczytu |
Ścieżka zasobu (bez domeny) do usługi docelowej (bez zapytania) zdefiniowanych w docelowym punkcie końcowym serwera proxy. Załóżmy na przykład, że serwer proxy interfejsu API wywołuje ten element docelowy:
W tym przykładzie pole Jeśli celem było to:
|
Żądanie docelowe |
target.copy.pathsuffix |
Wartość logiczna | Odczyt/zapis |
Jeśli ustawisz wartość „true” (prawda), żądanie przekazane z punktu ProxyEndpoint do punktu docelowego zachowuje ścieżkę sufiks (fragment ścieżki identyfikatora URI po identyfikatorze URI zdefiniowanym w bazie ProxyEndpoint) ). |
Żądanie docelowe |
target.copy.queryparams |
Wartość logiczna | Odczyt/zapis |
Jeśli ustawisz wartość „true” (prawda), żądanie przekazane z punktu końcowego ProxyEndpoint do tego punktu końcowego zachowuje zapytanie . |
Żądanie docelowe |
target.country |
Ciąg znaków | Tylko do odczytu |
Kraj certyfikatu TLS/SSL przedstawianego przez serwer docelowy |
Odpowiedź docelowa |
target.cn |
Ciąg znaków | Tylko do odczytu |
Wspólna nazwa docelowego punktu końcowego. Ma to znaczenie tylko wtedy, gdy docelowy punkt końcowy odnosi się do punktu końcowego TLS/SSL. |
Żądanie docelowe |
target.email.address |
Ciąg znaków | Tylko do odczytu |
Adres e-mail certyfikatu TLS/SSL przedstawionego przez serwer docelowy |
Odpowiedź docelowa |
target.expectedcn |
Ciąg znaków | Odczyt/zapis |
Oczekiwana wspólna nazwa docelowego punktu końcowego. Ma to znaczenie tylko wtedy, gdy Docelowy punkt końcowy odnosi się do punktu końcowego TLS/SSL. |
Żądanie do serwera proxy |
target.host |
Ciąg znaków | Tylko do odczytu |
Nazwa domeny usługi docelowej, która zwraca odpowiedź do serwera proxy interfejsu API. |
Odpowiedź docelowa |
target.ip |
Ciąg znaków | Tylko do odczytu |
Adres IP usługi docelowej, która zwraca odpowiedź do serwera proxy interfejsu API. |
Odpowiedź docelowa |
target.locality |
Ciąg znaków | Tylko do odczytu |
Lokalizacja (miasto) certyfikatu TLS/SSL prezentowanego przez serwer docelowy |
Odpowiedź docelowa |
target.name |
Ciąg znaków | Tylko do odczytu |
Cel, do którego dociera komunikat z docelowego punktu końcowego. |
Żądanie docelowe |
target.organization |
Ciąg znaków | Tylko do odczytu |
Organizacja certyfikatu TLS/SSL przedstawianego przez serwer docelowy. |
Odpowiedź docelowa |
target.organization.unit |
Ciąg znaków | Tylko do odczytu |
Jednostka organizacyjna certyfikatu TLS/SSL przedstawianego przez serwer docelowy. |
Odpowiedź docelowa |
target.port |
Liczba całkowita | Tylko do odczytu |
Numer portu usługi docelowej, która zwraca odpowiedź do serwera proxy interfejsu API. |
Odpowiedź docelowa |
target.received.end.time |
Ciąg znaków | Tylko do odczytu |
Godzina w postaci ciągu znaków, w której docelowy punkt końcowy zakończył otrzymywanie ze strony docelowej. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową sygnaturę czasową ilość. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej z numeru „1377112607413”... |
Odpowiedź docelowa |
target.received.end. |
Długi | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy docelowy punkt końcowy zakończył otrzymywanie odpowiedzi od wartości docelowej. Przykład: „1534783015000”. Ta wartość jest 64-bitową (długą) liczbą całkowitą określający liczbę milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. |
Odpowiedź docelowa |
target.received.start.time |
Ciąg znaków | Tylko do odczytu |
Godzina wyrażona w postaci ciągu znaków, od której element TargetEndpoint rozpoczął otrzymywanie ze strony docelowej. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową sygnaturę czasową ilość. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej numeru „1377112607413”. |
Odpowiedź docelowa |
target.received.start. |
Długi | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy docelowy punkt końcowy zaczął otrzymywać odpowiedź od wartości docelowej. Przykład: „1534783015000”. Ta wartość jest 64-bitową (długą) liczbą całkowitą określający liczbę milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. |
Odpowiedź docelowa |
target.scheme |
Ciąg znaków | Tylko do odczytu |
Początek zakresu: odpowiedź docelowa Zwraca http lub https w zależności od komunikatu żądania. |
Żądanie docelowe |
target.sent.end.time |
Ciąg znaków | Tylko do odczytu |
Wyrażony w postaci ciągu znaków moment, w którym serwer proxy przestał wysyłać żądanie do adres URL podany w punkcie końcowym TargetEndpoint. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową sygnaturę czasową ilość. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej numeru „1377112607413”. |
Żądanie docelowe |
target.sent.end.timestamp |
Długi | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy serwer proxy zakończył wysyłanie żądania na adres URL podany w punkcie końcowym TargetEndpoint. Przykład: „1377112607413”. Ta wartość jest 64-bitowa (długi) liczba całkowita zawierająca liczbę milisekund, które upłynęły od północy, 1 stycznia 1970 r. UTC. |
Żądanie docelowe |
target.sent.start.time |
Ciąg znaków | Tylko do odczytu |
Godzina, wyrażona w postaci ciągu znaków, od której serwer proxy rozpoczął wysyłanie żądania do adres URL podany w punkcie końcowym TargetEndpoint. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową sygnaturę czasową ilość. Na przykład „Wed, 21 Aug 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej numeru „1377112607413”. |
Żądanie docelowe |
target.sent.start.timestamp |
Długi | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy serwer proxy rozpoczął wysyłanie żądania na adres URL podany w punkcie końcowym TargetEndpoint. Przykład: „1534783015000”. Ta wartość jest 64-bitowa (długa) liczba całkowita określająca liczbę milisekund, które upłynęły od północy, w dniu 1 stycznia 1970 r. UTC. |
Żądanie docelowe |
target.ssl.enabled |
Wartość logiczna | Tylko do odczytu |
Określa, czy docelowy punkt końcowy działa z TLS/SSL. |
Żądanie do serwera proxy |
target.state |
Ciąg znaków | Tylko do odczytu |
Stan certyfikatu TLS/SSL prezentowanego przez serwer docelowy. |
Odpowiedź docelowa |
target.url |
Ciąg znaków | Odczyt/zapis |
Adres URL skonfigurowany w pliku XML elementu docelowego punktu końcowego lub adres URL celu dynamicznego (jeśli
|
Żądanie docelowe |
variable
Kontener właściwości variable.expectedcn
.
W tabeli poniżej opisano właściwości zmiennej variable
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
variable.expectedcn |
Ciąg znaków | Odczyt/zapis |
Zmienna widoczna dla wspólnej nazwy, jeśli działa przy użyciu TLS/SSL. |
Żądanie do serwera proxy |
Więcej informacji o pracy z TLS znajdziesz w Wprowadzenie do TLS/SSL
virtualhost
Określa szczegóły hosta wirtualnego.
W tabeli poniżej opisano właściwości zmiennej virtualhost
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
virtualhost.aliases.values |
Tablica ciągów znaków | Tylko do odczytu |
Aliasy hosta wirtualnego, w którym wystąpiło trafienie podczas określonego żądania. |
Żądanie do serwera proxy |
virtualhost.name |
Ciąg znaków | Tylko do odczytu |
Nazwa hosta wirtualnego, który obsługuje źródłowe żądanie klienta. |
Żądanie do serwera proxy |
virtualhost.ssl.enabled |
Wartość logiczna | Tylko do odczytu |
Zwraca wartość „true” (prawda) jeśli protokół TLS/SSL jest włączony w konfiguracji hosta wirtualnego. |
Żądanie do serwera proxy |
Więcej informacji o pracy z hostami wirtualnymi znajdziesz w artykule Konfigurowanie hostów wirtualnych