Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
W tej sekcji znajdziesz informacje o 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
Opis każdej z nich znajdziesz w kolejnych sekcjach.
apigee
Zmienna pomocnicza, która zawiera informacje o czasie wykonywania zasady.
W tej tabeli 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). | Zasada |
apiproxy
Opisuje serwer proxy interfejsu API.
W tej tabeli 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 serwera proxy |
apiproxy.revision |
Ciąg znaków | Tylko do odczytu | Numer wersji serwera proxy interfejsu API. np. „6”. | Żądanie serwera proxy |
Więcej informacji o pracy z serwerami proxy interfejsów API znajdziesz w artykule Omówienie interfejsów API i serwerów proxy API.
application
Kontener właściwości application.basepath
.
W tej tabeli 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 | Podstawowa ścieżka wdrożenia (określona podczas wdrażania interfejsu API). | Żądanie serwera proxy |
client
Aplikacja lub system, który wysłał żądanie do routera brzegowego.
W tej tabeli 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 pospolita podana w certyfikacie TLS/SSL prezentowana przez aplikację kliencką. |
Żądanie serwera proxy |
client.country |
Ciąg znaków | Tylko do odczytu |
Kraj w certyfikacie TLS/SSL przedstawianym przez aplikację kliencką. |
Żądanie serwera proxy |
client.email.address |
Ciąg znaków | Tylko do odczytu |
Adres e-mail w certyfikacie TLS/SSL przedstawionym przez aplikację kliencką. |
Żądanie serwera proxy |
client.host |
Ciąg znaków | Tylko do odczytu |
Adres IP hosta HTTP powiązany z żądaniem odebranym przez ProxyEndpoint. |
Żądanie serwera proxy |
client.ip |
Ciąg znaków | Tylko do odczytu |
Adres IP klienta lub systemu wysyłającego wiadomość do routera brzegowego. Może to być na przykład pierwotny adres IP klienta lub adres IP systemu równoważenia obciążenia. |
Żądanie serwera proxy |
client.locality |
Ciąg znaków | Tylko do odczytu |
Miejscowość (miasto) w certyfikacie TLS/SSL przedstawiona przez klienta. |
Żądanie serwera proxy |
client.organization |
Ciąg znaków | Tylko do odczytu | Organizacja w certyfikacie TLS/SSL przedstawiona przez klienta. (Nie musi to być organizacja w Apigee Edge). | Żądanie serwera proxy |
client.organization.unit |
Ciąg znaków | Tylko do odczytu |
Jednostka organizacyjna w certyfikacie TLS/SSL przedstawionym przez klienta. |
Żądanie serwera proxy |
client.port |
Liczba całkowita | Tylko do odczytu |
Port HTTP powiązany ze źródłowym żądaniem klienta wysyłanym do punktu końcowego ProxyEndpoint. |
Żądanie serwera proxy |
client.received.end.time |
Ciąg znaków | Tylko do odczytu |
Czas wyrażony w postaci ciągu znaków, o którym serwer proxy zakończył odbiór żądania od źródłowego klienta w punkcie ProxyEndpoint. Na przykład: środa, 21 sierpnia 2013 r., 19:16:47 czasu UTC. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową wartość sygnatury czasowej. Na przykład „Śr, 21 sie 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej 1377112607413. |
Żądanie serwera proxy |
client.received.end.timestamp |
Długa liczba całkowita | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy serwer proxy zakończył odbiór żądania od źródłowego klienta w punkcie końcowym ProxyEndpoint. Ta wartość jest 64-bitową (długą) liczbą całkowitą zawierającą liczbę milisekund, które upłynęły od północy 1 stycznia 1970 roku czasu UTC. |
Żądanie serwera proxy |
client.received.start.time |
Ciąg znaków | Tylko do odczytu |
Czas wyrażony w formie ciągu znaków, w którym serwer proxy zaczął odbierać żądanie od źródłowego klienta w punkcie końcowym ProxyEndpoint. Na przykład: śr, 21 sierpnia 2013 r. 19:16:47 UTC Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową wartość sygnatury czasowej. Na przykład „Śr, 21 sie 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej 1377112607413. |
Żądanie serwera proxy |
client.received.start.timestamp |
Długa liczba całkowita | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy serwer proxy zaczął odbierać żądanie od źródłowego klienta w punkcie końcowym ProxyEndpoint. Ta wartość jest 64-bitową (długą) liczbą całkowitą zawierającą liczbę milisekund, które upłynęły od północy 1 stycznia 1970 roku czasu UTC. |
Żądanie 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 wysłania wiadomości z żądaniem. |
Żądanie serwera proxy |
client.sent.end.time |
Ciąg znaków | Tylko do odczytu |
Wyrażony w postaci ciągu znaków czas, o którym serwer proxy zakończył wysyłanie odpowiedzi z punktu ProxyEnd do klienta. Na przykład: „Śr, 21 sie 2013 19:16:47 UTC”. Ta wartość jest ciągiem znaków 32-bitowej wartości |
PostClientFlow |
client.sent.end.timestamp |
Długa liczba całkowita | Tylko do odczytu | Wartość sygnatury czasowej określająca, kiedy ProxyEndpoint zakończył zwrócenie odpowiedzi do źródłowej aplikacji klienckiej. Jest to 64-bitowa (długa) liczba całkowita zawierająca liczbę milisekund, które upłynęły od północy, 1 stycznia 1970 r. czasu UTC. | PostClientFlow |
client.sent.start.time |
Ciąg znaków | Tylko do odczytu | Czas wyrażony w postaci ciągu znaków, kiedy punkt ProxyEndpoint zaczął zwracać odpowiedź do źródłowej aplikacji klienckiej. Na przykład „Śr, 21 sierpnia 2013 r., 19:16:47 UTC”.
Ta wartość jest ciągiem znaków 32-bitowej wartości |
PostClientFlow |
client.sent.start.timestamp |
Długa liczba całkowita | Tylko do odczytu | Gdy serwer proxy zaczął wysyłać do klienta odpowiedź z punktu końcowego ProxyEndpoint. Ta wartość jest wyrażona jako 64-bitowa (długa) liczba całkowita zawierająca liczbę milisekund, które upłynęły od północy, 1 stycznia 1970 roku czasu UTC. | PostClientFlow |
client.ssl.enabled |
Ciąg znaków | Tylko do odczytu |
Wartość „true” (prawda), jeśli punkt ProxyEndpoint jest skonfigurowany do obsługi TLS/SSL. W przeciwnym razie ma wartość „false” (fałsz). |
Żądanie serwera proxy |
client.state |
Ciąg znaków | Tylko do odczytu |
Stan w certyfikacie TLS/SSL przedstawionym przez klienta. |
Żądanie serwera proxy |
current
Zawiera informacje o bieżącym procesie serwera proxy interfejsu API.
W tej tabeli 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 wykonywanego obecnie procesu (na przykład „PreFlow”, „PostFlow” lub nazwa przepływu warunkowego). | Żądanie serwera proxy |
current.flow.description |
Ciąg znaków | Tylko do odczytu | Opis obecnie wykonywanego procesu. Jest taka sama jak wartość elementu <Description> w konfiguracji XML przepływu. |
Żądanie serwera proxy |
Właściwości te możesz wyświetlić w widoku śledzenia w interfejsie Edge. Domyślnie te właściwości nie są jednak widoczne w widoku śledzenia w klasycznym interfejsie.
environment
Kontener właściwości environment.name
.
W tej tabeli 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 została zrealizowana transakcja. | Żądanie serwera proxy |
error
Obiekt kontekstowy reprezentujący komunikat o błędzie w procesie błędu.
W tej tabeli 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łędów. |
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 tylko przed wykonaniem przepływu błędu. |
Błąd |
error.status.code |
Liczba całkowita | Tylko do odczytu |
Kod stanu HTTP powiązany z błędem. np. „400”. |
Błąd |
error.reason.phrase |
Ciąg znaków | Tylko do odczytu |
Hasło powiązane z błędem. Na przykład: „Złe żą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 procesu, 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 ustawiona na kod błędu środowiska wykonawczego, gdy zasada zgłasza błąd. Wartości kodów błędów są różne dla poszczególnych zasad.
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 wskazana w tabeli Błędy środowiska wykonawczego w poszczególnych tematach z odwołaniami do zasad. | Błąd |
is
Kontener właściwości is.error
.
W tej tabeli 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 serwera proxy |
loadbalancing
Zawiera informacje o stanie równoważenia obciążenia w TargetEndpoint.
W tej tabeli 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ę przetworzyć podczas równoważenia obciążenia w punkcie końcowym TargetEndpoint. |
Docelowa odpowiedź |
loadbalancing.isfallback |
Wartość logiczna | Tylko do odczytu |
Wartość „true” (prawda), jeśli włączono opcję zastępczą dla serwera docelowego wywoływanego podczas równoważenia obciążenia w docelowym punkcie końcowym. |
Docelowa odpowiedź |
loadbalancing.targetserver |
Ciąg znaków | Tylko do odczytu |
Serwer docelowy został wywołany podczas równoważenia obciążenia w punkcie końcowym TargetEndpoint. Ustaw tylko wtedy, gdy element |
Docelowa odpowiedź |
message
Obiekt kontekstowy z tą samą wartością co request
w procesie żądania lub jako response
w procesie odpowiedzi albo jako error
w procesie błędu.
W tej tabeli opisano właściwości zmiennej message
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
message |
message |
Odczyt/zapis |
Obiekt kontekstowy z tą samą wartością co |
Żądanie serwera proxy |
message.content |
Ciąg znaków | Odczyt/zapis |
Treść żądania, odpowiedzi lub komunikatu o błędzie. |
Żądanie serwera proxy |
message.formparam.param_name |
Ciąg znaków | Odczyt/zapis |
Wartość określonego parametru formularza. |
Żądanie serwera proxy |
message.formparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego parametru formularza w wiadomości. |
Żądanie serwera proxy |
message.formparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wartości określonych parametrów formularza w wiadomości. |
Żądanie serwera proxy |
message.formparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich parametrów formularza w wiadomości. |
Żądanie serwera proxy |
message.formparams.names |
Kolekcja | Tylko do odczytu |
Wartość wszystkich parametrów formularza w wiadomości. |
Żądanie serwera proxy |
message.formstring |
Ciąg znaków | Tylko do odczytu |
Wartość ciągu znaków formularza w wiadomości. |
Żądanie 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 pierwszego przecinka. Jeśli chcesz otrzymać cały nagłówek, użyj formularza |
Żądanie serwera proxy |
message.header.header_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość określonej wartości nagłówka N-tego w wiadomości (żądaniu lub odpowiedzi), w zależności od stanu procesu. Apigee Edge dzieli wartości tekstu nagłówka przecinkami. Pamiętaj, że indeks, dla którego wartość jest używana jako N, wynosi 1, a nie 0. Jeśli np. nagłówek |
Żądanie serwera proxy |
message.header.header_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonej nazwy nagłówka HTTP w wiadomości. |
Żądanie 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 serwera proxy |
message.headers.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich nagłówków HTTP w wiadomości. |
Żądanie serwera proxy |
message.headers.names |
Kolekcja | Tylko do odczytu |
Wartość wszystkich nagłówków HTTP w wiadomości |
Żądanie serwera proxy |
message.path |
Ciąg znaków | Odczyt/zapis |
Pełna ścieżka wiadomości żądania w adresie URL bez parametrów zapytania. |
Żądanie serwera proxy |
message.queryparam.param_name |
Ciąg znaków | Tylko do odczytu |
Zwraca określony parametr zapytania dotyczącego wiadomości. |
Żądanie serwera proxy |
message.queryparam.param_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość parametru zapytania Nth w wiadomości. Jeśli np. Aby zapisać wiele wartości dla pojedynczej nazwy parametru zapytania, np. „type=siteid:1&type=language:us-en&type=currency:USD”, ustaw ten kod:
|
Żądanie serwera proxy |
message.queryparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości konkretnego parametru zapytania w wiadomości w postaci listy rozdzielonej przecinkami. Jeśli np. ciąg zapytania to |
Żądanie 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 ProxyEndpoint z aplikacji klienckiej. |
Żądanie serwera proxy |
message.queryparams.count |
Liczba całkowita | Tylko do odczytu |
Łączna liczba wszystkich parametrów zapytania powiązanych z żądaniem wysłanym do punktu końcowego ProxyEndpoint z aplikacji klienckiej. |
Żądanie serwera proxy |
message.queryparams.names |
Kolekcja | Tylko do odczytu |
Lista wszystkich nazw parametrów zapytania powiązanych z żądaniem wysłanym do ProxyEndpoint z aplikacji klienckiej. Informacje o tym, jak iterować nazwy parametrów zapytania za pomocą JavaScriptu, znajdziesz w tym poście na Forum Apigee: Jak iterować kolekcję z parametru „request.queryparams.names” w języku JS? w Społeczności Apigee. |
Żądanie serwera proxy |
message.querystring |
Ciąg znaków | Tylko do odczytu |
Ciąg tekstowy zawierający wszystkie nazwy parametrów zapytania i wartości powiązane z żądaniem wysłanym do ProxyEndpoint z aplikacji klienckiej. Na przykład w żądaniu „http://api.apifactory.com/inventors?name=nick&surname=danger” wartość |
Żądanie serwera proxy |
message.reason.phrase |
Ciąg znaków | Tylko do odczytu |
Reasonphrase w odpowiedzi na wiadomość od docelowego adresu e-mail. |
Docelowa odpowiedź |
message.status.code |
Liczba całkowita | Tylko do odczytu |
Kod stanu HTTP wiadomości z odpowiedzią z środowiska docelowego. |
Docelowa odpowiedź |
message.transport.message |
TransportMessage | Tylko do odczytu |
Komunikat typu TransportMessage, który jest obiektem kontekstowym. |
Żądanie 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 w żądaniu „http://api.apifactory.com/inventors?name=nikola&surname=tesla” ta zmienna zwraca „inventors?name=nikola&surname=tesla”. |
Żądanie serwera proxy |
message.verb |
Ciąg znaków | Tylko do odczytu |
Czasownik HTTP ( |
Żądanie serwera proxy |
message.version |
Ciąg znaków | Odczyt/zapis |
Wersja HTTP powiązana z żądaniem wysłanym przez aplikację kliencką do ProxyEndpoint. |
Żądanie serwera proxy |
Więcej informacji o wiadomościach znajdziesz w artykule Dokumentacja funkcji szablonu wiadomości.
messageid
Kontener z globalnie unikalnym identyfikatorem żądania.
W tej tabeli 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 globalnie unikalny identyfikator żądania, który obejmuje nazwę hosta routera. Ten identyfikator umożliwia śledzenie żądań odbieranych na routerze po ich wysłaniu do podmiotu przetwarzającego wiadomości. Ten identyfikator jest logowany w logach błędów Edge, aby skorelować |
Żądanie serwera proxy |
organization
Kontener właściwości organization.name
.
W tej tabeli 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 serwera proxy |
Więcej informacji o organizacjach znajdziesz w artykule Omówienie organizacji.
proxy
Konfiguracja serwera proxy interfejsu API.
W tej tabeli 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 bazowa to fragment identyfikatora URI, który występuje po hoście w adresie URL. Identyfikatory URI przepływu warunkowego są po ścieżce podstawowej. W adresie URL „http://myorg-test.apigee.net/v2/Weatherapi/forecastrss?w=12797282”:
Można to sprawdzić tylko przez sprawdzenie definicji serwera proxy interfejsu API lub sprawdzenie wartości zmiennej proxy.basepath. Sufiks ścieżki serwera proxy jest zgodny ze ścieżką podstawową („/prognozy”) wraz z parametrami zapytania. Jeśli w konfiguracji serwera proxy interfejsu API zdefiniujesz dynamiczną ścieżkę podstawową, np. „/v2/*/Weatherapi”, ta zmienna będzie ustawiona na ścieżkę dynamiczną („/v2/*/Weatherapi”), mimo że ścieżka ta przyjmuje wartość statyczną, np. „/v2/foo/Weatherapi”. |
Żądanie serwera proxy |
proxy.client.ip |
Ciąg znaków | Tylko do odczytu |
Adres |
Żądanie serwera proxy |
proxy.name |
Ciąg znaków | Tylko do odczytu |
Atrybut name skonfigurowany dla punktu ProxyEndpoint. |
Żądanie serwera proxy |
proxy.pathsuffix |
Ciąg znaków | Tylko do odczytu |
Wartość sufiksu ścieżki bazowej serwera proxy interfejsu API, która jest wysyłana z klienta i odbierana w punkcie końcowym ProxyEndpoint. Ścieżka bazowa jest zdefiniowana jako komponent ścieżki, który jednoznacznie identyfikuje serwer proxy interfejsu API. Dostępny publicznie adres URL serwera proxy interfejsu API składa się z nazwy organizacji, środowiska, w którym został wdrożony serwer proxy, ścieżki bazowej, sufiksu ścieżki podstawowej i wszelkich parametrów zapytania. Na przykład w żądaniu wysłanym do |
Żądanie serwera proxy |
proxy.url |
Ciąg znaków | Tylko do odczytu |
Pobiera pełny adres URL powiązany z żądaniem serwera proxy odebranym przez ProxyEndpoint wraz z obecnymi parametrami zapytania.
Jeśli serwer proxy jest wywoływany za pomocą metody Przykład tworzenia adresu URL |
Żądanie serwera proxy |
Więcej informacji o pracy z serwerami proxy interfejsów API znajdziesz w artykule Omówienie interfejsów API i serwerów proxy API.
request
Pełne żądanie z całym ładunkiem.
Więcej informacji o danych żądań znajdziesz w artykule W jaki sposób dane żądań są przekazywane do serwera backendu?
W tej tabeli opisano właściwości zmiennej request
:
Właściwość | Typ | Odczyt/zapis | Opis | Początek zakresu |
---|---|---|---|---|
request |
message |
Tylko do odczytu |
Pełne żądanie z całym ładunkiem. |
Żądanie serwera proxy |
request.content |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia ładunek wiadomości z żądaniem. |
Żądanie 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 aplikacji klienckiej. |
Żądanie serwera proxy |
request.formparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości konkretnego parametru formularza w żądaniu w postaci listy rozdzielonej przecinkami. Jeśli np. ładunek to „a=hello&x=visitting&a=world”, wartość |
Żądanie 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 serwera proxy |
request.formparam.param_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość N-tego parametru konkretnego formularza w wiadomości. Jeśli np. ciąg formularza to „a=hello&a=world”, zwracaną wartością |
Żądanie serwera proxy |
request.formparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich parametrów formularza powiązanych z żądaniem wysłanym z aplikacji klienckiej. |
Żądanie serwera proxy |
request.formparams.names |
Kolekcja | Tylko do odczytu |
Lista wszystkich nazw parametrów formularza powiązanych z żądaniem. |
Żądanie serwera proxy |
request.formstring |
Ciąg znaków | Tylko do odczytu |
Pełne pole Na przykład „name=test&type=first&group=A”. |
Żądanie 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 pierwszego przecinka. Jeśli chcesz przesłać cały nagłówek, użyj formularza |
Żądanie serwera proxy |
request.header.header_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość określonej wartości nagłówka Nth w żądaniu. Apigee Edge dzieli wartości tekstu nagłówka przecinkami. Pamiętaj, że indeks, dla którego wartość jest używana jako wartość N, wynosi 1, a nie 0. Jeśli np. nagłówek |
Żądanie serwera proxy |
request.header.header_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości konkretnego nagłówka w żądaniu. |
Żądanie serwera proxy |
request.header.header_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości konkretnego nagłówka w żądaniu. |
Żądanie serwera proxy |
request.headers.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich nagłówków w żądaniu. |
Żądanie serwera proxy |
request.headers.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich nagłówków w żądaniu. |
Żądanie serwera proxy |
request.path |
Ciąg znaków | Tylko do odczytu |
Ścieżka 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”, a wartością |
Żądanie serwera proxy |
request.queryparam.param_name |
Ciąg znaków | Odczyt/zapis |
Wartość konkretnego parametru zapytania znalezionego w żądaniu. |
Żądanie serwera proxy |
request.queryparam.param_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość parametru zapytania Nth w żądaniu. Jeśli np. Aby zapisać wiele wartości dla pojedynczej nazwy parametru zapytania, np. „type=siteid:1&type=language:us-en&type=currency:USD”, ustaw ten kod:
|
Żądanie serwera proxy |
request.queryparam.param_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości konkretnego parametru zapytania w żądaniu w postaci listy rozdzielonej przecinkami. Jeśli np. |
Żądanie serwera proxy |
request.queryparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości konkretnego parametru zapytania w żądaniu. |
Żądanie serwera proxy |
request.queryparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich parametrów zapytania w żądaniu. |
Żądanie serwera proxy |
request.queryparams.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich parametrów zapytania w żądaniu. Informacje o tym, jak iterować nazwy parametrów zapytania za pomocą JavaScriptu, znajdziesz w sekcji Jak iterować kolekcję z parametru „request.queryparams.names” w JS? w społeczności Apigee. |
Żądanie 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 np. żądanie to „http://host.com/123?name=first&surname=second&place=address”, ta zmienna zwraca „name=first&surname=second&place=address”. |
Żądanie serwera proxy |
request.transportid |
Ciąg znaków | Tylko do odczytu |
Identyfikator żądania w postaci typu TransportMessage, który jest obiektem kontekstowym. |
Żądanie serwera proxy |
request.transport.message |
Transport wiadomości | Tylko do odczytu |
Żądanie typu TransportMessage, który jest obiektem ciągłym. |
Żądanie serwera proxy |
request.uri |
Ciąg znaków | Tylko do odczytu |
W przypadku serwera proxy interfejsu API serwer proxy
Wskazuje
W żądaniu W odpowiedzi Różnica polega na tym, że pierwotne żądanie dotarło do serwera proxy, a następnie wysyła on kolejne żądanie do usługi docelowej. Załóżmy, że wykonywane jest poniższe wywołanie naszego przykładowego serwera proxy, którego ścieżka bazowa to „/my-mock-proxy”:
A serwer proxy wywołuje:
Spowoduje to dodanie do adresu URL ciągu „/user?user=Dude”.
|
Żądanie serwera proxy (różnica w odpowiedzi) |
request.url |
Ciąg znaków | Tylko do odczytu |
Pełny adres URL żądania wysłanego do docelowego punktu końcowego wraz z parametrami ciągu zapytania, ale 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”, a docelowy punkt końcowy to „http://example.com:8080”, wartość będzie wyglądać tak:
|
Docelowa odpowiedź |
request.verb |
Ciąg znaków | Tylko do odczytu |
Czasownik HTTP użyty w żądaniu. np. „GET”, „PUT” i „DELETE”. |
Żądanie serwera proxy |
request.version |
Ciąg znaków | Tylko do odczytu |
Wersja HTTP żądania. Na przykład „1.1”. |
Żądanie serwera proxy |
response
Pełna odpowiedź z całym ładunkiem.
W tej tabeli 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. |
Docelowa odpowiedź |
response.content |
Ciąg znaków | Odczyt/zapis |
Ładunek treści wiadomości z odpowiedzią zwróconej przez cel. |
Docelowa odpowiedź |
response.formparam.param_name |
Ciąg znaków | Odczyt/zapis |
Wartość parametru formularza w odpowiedzi. |
Docelowa odpowiedź |
response.formparam.param_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego parametru formularza w odpowiedzi. |
Docelowa odpowiedź |
response.formparams.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich prametrów formularza w odpowiedzi. |
Docelowa odpowiedź |
response.formparams.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich parametrów formularza w odpowiedzi. |
Docelowa odpowiedź |
response.header.header_name |
Ciąg znaków | Odczyt/zapis |
Pobiera lub ustawia w odpowiedzi wartość określonego nagłówka HTTP. Jeśli tekst nagłówka zawiera przecinek, Apigee Edge ustala wiele wartości. W tym przypadku Aby przeczytać cały nagłówek, użyj formularza |
Docelowa odpowiedź |
response.header.header_name. |
Kolekcja | Tylko do odczytu |
Wszystkie wartości określonego nagłówka HTTP w odpowiedzi. |
Docelowa odpowiedź |
response.header.header_name. |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich wartości określonego nagłówka HTTP w odpowiedzi. |
Docelowa odpowiedź |
response.header.header_name.N |
Ciąg znaków | Odczyt/zapis |
Wartość określonej wartości nagłówka Nth w odpowiedzi. Apigee Edge dzieli wartości tekstu nagłówka przecinkami. Pamiętaj, że indeks, dla którego wartość jest używana jako wartość N, wynosi 1, a nie 0. Jeśli np. nagłówek |
Docelowa odpowiedź |
response.headers.count |
Liczba całkowita | Tylko do odczytu |
Liczba wszystkich nagłówków w odpowiedzi. |
Docelowa odpowiedź |
response.headers.names |
Kolekcja | Tylko do odczytu |
Nazwy wszystkich nagłówków w odpowiedzi. |
Docelowa odpowiedź |
response.reason.phrase |
Ciąg znaków | Odczyt/zapis |
Uzasadnienie konkretnego żądania. |
Docelowa odpowiedź |
response.status.code |
Liczba całkowita | Odczyt/zapis |
Kod odpowiedzi zwrócony w odpowiedzi na żądanie. Tej zmiennej możesz używać do zastępowania kodu stanu odpowiedzi, który jest przechowywany w pliku |
Docelowa odpowiedź |
response.transport.message |
Ciąg znaków | Tylko do odczytu |
Odpowiedź typu TransportMessage, który jest obiektem ciągłym. |
Docelowa odpowiedź |
route
Określa nazwy punktów końcowych <RouteRule>
i TargetEndpoint.
W tej tabeli 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 zasobu |
Docelowe żądanie |
route.target |
Ciąg znaków | Tylko do odczytu |
Nazwa wykonanego punktu końcowego docelowego (TargetEndpoint). Na przykład „domyślne”. |
Docelowe żądanie |
router
Kontener dla usługi router.uuid
, która została wycofana.
W tej tabeli 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 i zwracano wartość null. (Dawniej identyfikator UUID routera obsługującego serwer proxy). |
Żądanie serwera proxy |
servicecallout
Opisuje element TargetEndpoint na potrzeby zasady ServiceCallout.
W tej tabeli 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 docelowego określona w zasadzie ServiceCallout. Jest to przydatne tylko wtedy, gdy docelowy punkt końcowy odnosi się do punktu końcowego TLS/SSL. |
Żądanie serwera proxy |
servicecallout.policy_name.target.url |
Ciąg znaków | Odczyt/zapis |
Adres URL docelowego punktu końcowego określonego w konkretnej zasadzie ServiceCallout. |
Żądanie serwera proxy |
servicecallout.requesturi |
Ciąg znaków | Odczyt/zapis |
Identyfikator URI elementu TargetEndpoint dla zasady ServiceCallout. Identyfikator URI to adres URL docelowego punktu końcowego bez specyfikacji protokołu i domeny. |
Żądanie serwera proxy |
system
Określa adres IP systemu, a także szczegółowe informacje o serwerze proxy.
W tej tabeli 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 serwera proxy |
system.pod.name |
Ciąg znaków | Tylko do odczytu |
Nazwa poda, w którym działa serwer proxy. |
Żądanie serwera proxy |
system.region.name |
Ciąg znaków | Tylko do odczytu |
Nazwa regionu centrum danych, w którym działa serwer proxy. |
Żądanie serwera proxy |
system.time |
Ciąg znaków | Tylko do odczytu |
Czas odczytu tej zmiennej. Na przykład: „Śr, 21 sierpnia 2013 r. 19:16:47 UTC”. Ta wartość jest ciągiem znaków reprezentującym odpowiednią wartość |
Żądanie serwera proxy |
system.time.year |
Liczba całkowita | Tylko do odczytu |
Roczna część kolumny |
Żądanie serwera proxy |
system.time.month |
Liczba całkowita | Tylko do odczytu |
Miesięczna część kolumny |
Żądanie serwera proxy |
system.time.day |
Liczba całkowita | Tylko do odczytu |
Część |
Żądanie serwera proxy |
system.time.dayofweek |
Liczba całkowita | Tylko do odczytu |
Dzień tygodnia |
Żądanie serwera proxy |
system.time.hour |
Liczba całkowita | Tylko do odczytu |
Część parametru |
Żądanie serwera proxy |
system.time.minute |
Liczba całkowita | Tylko do odczytu |
Minutowa część |
Żądanie serwera proxy |
system.time.second |
Liczba całkowita | Tylko do odczytu |
Druga część |
Żądanie serwera proxy |
system.time.millisecond |
Liczba całkowita | Tylko do odczytu |
Część milisekundowa wartości |
Żądanie serwera proxy |
system.time.zone |
Ciąg znaków | Tylko do odczytu |
Strefa czasowa systemu. |
Żądanie serwera proxy |
system.timestamp |
Długa liczba całkowita | 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. np. „1534783015000”. |
Żądanie serwera proxy |
system.uuid |
Ciąg znaków | Tylko do odczytu |
Identyfikator UUID procesora wiadomości obsługującego serwer proxy. |
Żądanie serwera proxy |
target
Opisuje element docelowy żądania.
W tej tabeli 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 z wyłączeniem parametrów zapytania określona w docelowym punkcie końcowym serwera proxy. Załóżmy, że serwer proxy interfejsu API wywołuje ten cel:
W tym przykładzie Gdyby wartości docelowe były takie:
|
Docelowe żądanie |
target.copy.pathsuffix |
Wartość logiczna | Odczyt/zapis |
Gdy ustawisz wartość „true” (prawda), żądanie przekazane z punktu ProxyEndpoint do docelowego punktu końcowego zachowuje sufiks ścieżki (fragment ścieżki URI po identyfikatorze URI zdefiniowanym w ścieżce bazowej ProxyEndpoint). |
Docelowe żądanie |
target.copy.queryparams |
Wartość logiczna | Odczyt/zapis |
Gdy ustawisz wartość „true” (prawda), żądanie przekazane z ProxyEndpoint do docelowego punktu końcowego zachowuje parametry zapytania. |
Docelowe żądanie |
target.country |
Ciąg znaków | Tylko do odczytu |
Kraj certyfikatu TLS/SSL przedstawianego przez serwer docelowy |
Docelowa odpowiedź |
target.cn |
Ciąg znaków | Tylko do odczytu |
Wspólna nazwa punktu końcowego docelowego. Jest to przydatne tylko wtedy, gdy docelowy punkt końcowy odnosi się do punktu końcowego TLS/SSL. |
Docelowe żądanie |
target.email.address |
Ciąg znaków | Tylko do odczytu |
Adres e-mail certyfikatu TLS/SSL przedstawianego przez serwer docelowy |
Docelowa odpowiedź |
target.expectedcn |
Ciąg znaków | Odczyt/zapis |
Oczekiwana wspólna nazwa punktu końcowego docelowego. Jest to przydatne tylko wtedy, gdy docelowy punkt końcowy odnosi się do punktu końcowego TLS/SSL. |
Żądanie serwera proxy |
target.host |
Ciąg znaków | Tylko do odczytu |
Nazwa domeny usługi docelowej zwracającej odpowiedź na serwer proxy interfejsu API. |
Docelowa odpowiedź |
target.ip |
Ciąg znaków | Tylko do odczytu |
Adres IP usługi docelowej zwracającej odpowiedź na serwer proxy interfejsu API. |
Docelowa odpowiedź |
target.locality |
Ciąg znaków | Tylko do odczytu |
Lokalizacja (miasto) certyfikatu TLS/SSL przedstawianego przez serwer docelowy |
Docelowa odpowiedź |
target.name |
Ciąg znaków | Tylko do odczytu |
Cel, do którego dociera wiadomość z punktu końcowego. |
Docelowe żądanie |
target.organization |
Ciąg znaków | Tylko do odczytu |
Organizacja certyfikatu TLS/SSL przedstawianego przez serwer docelowy. |
Docelowa odpowiedź |
target.organization.unit |
Ciąg znaków | Tylko do odczytu |
Jednostka organizacyjna certyfikatu TLS/SSL przedstawianego przez serwer docelowy. |
Docelowa odpowiedź |
target.port |
Liczba całkowita | Tylko do odczytu |
Numer portu usługi docelowej zwracającej odpowiedź do serwera proxy interfejsu API. |
Docelowa odpowiedź |
target.received.end.time |
Ciąg znaków | Tylko do odczytu |
Czas podany w formie ciągu znaków, w którym punkt końcowy zakończył odbieranie odpowiedzi z miejsca docelowego. Na przykład: „Śr, 21 sierpnia 2013 r. 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową wartość sygnatury czasowej. Na przykład „Śr, 21 sie 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej „1377112607413”. |
Docelowa odpowiedź |
target.received.end. |
Długa liczba całkowita | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy docelowy punkt końcowy zakończył odbieranie odpowiedzi z miejsca docelowego. Na przykład „1534783015000”. Ta wartość jest 64-bitową (długą) liczbą całkowitą określającą liczbę milisekund, które upłynęły od północy 1 stycznia 1970 roku czasu UTC. |
Docelowa odpowiedź |
target.received.start.time |
Ciąg znaków | Tylko do odczytu |
Czas podany w formie ciągu znaków, w którym punkt końcowy zaczął otrzymywać odpowiedź z miejsca docelowego. Na przykład: „Śr, 21 sierpnia 2013 r. 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową wartość sygnatury czasowej. Na przykład „śr, 21 sie 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej „1377112607413”. |
Docelowa odpowiedź |
target.received.start. |
Długa liczba całkowita | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy docelowy punkt końcowy zaczął otrzymywać odpowiedź z miejsca docelowego. Na przykład „1534783015000”. Ta wartość jest 64-bitową (długą) liczbą całkowitą określającą liczbę milisekund, które upłynęły od północy 1 stycznia 1970 roku czasu UTC. |
Docelowa odpowiedź |
target.scheme |
Ciąg znaków | Tylko do odczytu |
Początek zakresu: odpowiedź docelowa Zwraca http lub https w zależności od komunikatu z żądaniem. |
Docelowe żądanie |
target.sent.end.time |
Ciąg znaków | Tylko do odczytu |
Czas wyrażony w formie ciągu znaków, w którym serwer proxy przestał wysyłać żądanie na adres URL podany w docelowym punkcie końcowym. Na przykład: „Śr, 21 sierpnia 2013 r. 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową wartość sygnatury czasowej. Na przykład „śr, 21 sie 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej „1377112607413”. |
Docelowe żądanie |
target.sent.end.timestamp |
Długa liczba całkowita | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy serwer proxy zakończył wysyłanie żądania pod adres URL podany w docelowym punkcie końcowym. Na przykład „1377112607413”. Ta wartość jest 64-bitową (długą) liczbą całkowitą zawierającą liczbę milisekund, które upłynęły od północy 1 stycznia 1970 roku czasu UTC. |
Docelowe żądanie |
target.sent.start.time |
Ciąg znaków | Tylko do odczytu |
Czas wyrażony w formie ciągu znaków, w którym serwer proxy rozpoczął wysyłanie żądania do adresu URL określonego w docelowym punkcie końcowym. Na przykład: „Śr, 21 sierpnia 2013 r. 19:16:47 UTC”. Ta wartość czasu jest ciągiem znaków reprezentującym odpowiednią 32-bitową wartość sygnatury czasowej. Na przykład „śr, 21 sie 2013 19:16:47 UTC” odpowiada wartości sygnatury czasowej „1377112607413”. |
Docelowe żądanie |
target.sent.start.timestamp |
Długa liczba całkowita | Tylko do odczytu |
Wartość sygnatury czasowej określająca, kiedy serwer proxy rozpoczął wysyłanie żądania pod adres URL podany w docelowym punkcie końcowym. Na przykład „1534783015000”. Ta wartość jest 64-bitową (długą) liczbą całkowitą określającą liczbę milisekund, które upłynęły od północy, 1 stycznia 1970 r. czasu UTC. |
Docelowe żądanie |
target.ssl.enabled |
Wartość logiczna | Tylko do odczytu |
Określa, czy obiekt TargetEndpoint jest uruchomiony w protokole TLS/SSL. |
Żądanie serwera proxy |
target.state |
Ciąg znaków | Tylko do odczytu |
Stan certyfikatu TLS/SSL przedstawianego przez serwer docelowy. |
Docelowa odpowiedź |
target.url |
Ciąg znaków | Odczyt/zapis |
Adres URL skonfigurowany w pliku XML TargetEndpoint lub URL celu dynamicznego (jeśli |
Docelowe żądanie |
variable
Kontener właściwości variable.expectedcn
.
W tej tabeli 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 jest uruchomiona w TLS/SSL. |
Żądanie serwera proxy |
Więcej informacji o pracy z protokołem TLS znajdziesz we wprowadzeniu do TLS/SSL.
virtualhost
Określa szczegółowe informacje o hoście wirtualnym.
W tej tabeli 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 przypadku którego występuje określone żądanie. |
Żądanie serwera proxy |
virtualhost.name |
Ciąg znaków | Tylko do odczytu |
Nazwa hosta wirtualnego, który obsługuje źródłowe żądanie klienta. |
Żądanie 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 serwera proxy |
Więcej informacji o pracy z hostami wirtualnymi znajdziesz w artykule o konfigurowaniu hostów wirtualnych.