Property-Referenz für virtuelle Hosts

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

Darstellung eines virtuellen Hosts

Das XML-Objekt, das Sie zum Definieren eines virtuellen Hosts verwenden, basiert auf Ihrer Version von Edge: Cloud oder eine private Cloud erstellen.

Wenn Sie Private Cloud-Kunde sind, müssen Sie dafür sorgen, dass Sie den richtigen XML-Code für Ihre Version von Edge.

Cloud und Private Cloud 4.17.01 und höher

<VirtualHost name="vhostName">
    <Port>portNumber</Port>
    <BaseUrl>http://myCo.com</BaseUrl>
    <OCSPStapling>offOn</OCSPStapling>
    <HostAliases>
        <HostAlias>hostAlias</HostAlias>
    </HostAliases>
    <Interfaces>
        <!-- Private Cloud only -->
        <Interface>interfaceName</Interface>
    </Interfaces>
    <RetryOptions>
        <RetryOption>option</RetryOption>
    </RetryOptions>
    <ListenOptions>
        <ListenOption>option</ListenOption>
    </ListenOptions>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
        <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors>
    </SSLInfo>
    <!-- UseBuiltInFreeTrialCert is for Edge Cloud only -->
    <UseBuiltInFreeTrialCert>trueFalse</UseBuiltInFreeTrialCert>
    <PropagateTLSInformation>
        <!-- PropagateTLSInformation is Alpha in the Cloud only -->
        <ConnectionProperties>trueFalse</ConnectionProperties>
        <ClientProperties>trueFalse</ClientProperties>
    </PropagateTLSInformation>
    <Properties>
        <Property name="proxy_read_timeout">timeout</Property>
        <Property name="keepalive_timeout">timeout</Property>
        <Property name="proxy_request_buffering">onOff</Property>
        <Property name="proxy_buffering">onOff</Property>
        <!-- ssl_protocols is Private Cloud only -->
        <Property name="ssl_protocols">protocolList</Property>
        <Property name="ssl_ciphers">cipherList</Property>
    </Properties>
</VirtualHost>

Private Cloud 4.16.01 bis 4.16.09

<VirtualHost name="vhostName">
    <Port>portNumber</Port>
    <HostAliases>
        <HostAlias>hostAlias</HostAlias>
    </HostAliases>
    <Interfaces>
        <Interface>interfaceName</Interface>
    </Interfaces>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
        <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors>
    </SSLInfo>
</VirtualHost>

Private Cloud 4.15.07 und früher

<VirtualHost name="vhostName">
    <Port>portNumber</Port>
    <HostAliases>
        <HostAlias>hostAlias</HostAlias>
    </HostAliases>
    <Interfaces>
        <Interface>interfaceName</Interface>
    </Interfaces>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>keystore</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>truststore</TrustStore>
        <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors>
        <Ciphers>
             <Cipher>cipher</Cipher>
             <Cipher>cipher</Cipher>
         </Ciphers>
         <Protocols>
             <Protocol>protocol</Protocol>
             <Protocol>protocol</Protocol>
         </Protocols>
    </SSLInfo>
</VirtualHost>

Konfigurationsattribute des virtuellen Hosts

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die Sie zur Konfiguration eines virtuellen Hosts verwenden:

Attribute Beschreibung Standard Erforderlich
VirtualHost

Gibt den Namen des virtuellen Hosts an. Mit diesem Namen verweisen Sie auf den virtuellen Host. wenn Sie einen API-Proxy konfigurieren.

Im Attribut name können nur folgende Zeichen verwendet werden: A-Z0-9._\-$%.

Keine Ja
Port

Gibt die vom virtuellen Host verwendete Portnummer an. Vergewissern Sie sich, dass der Anschluss auf der Edge Router.

Wenn Sie einen Port in einem hostalias-Element angeben, ist die Portnummer die durch <Port> angegeben werden, müssen übereinstimmen.

Für die Cloud: Sie müssen beim Erstellen eines virtuellen Hosts Port 443 angeben. Wenn wird der Port standardmäßig auf 443 gesetzt. Wenn Sie bereits einen virtuellen Host haben, Port einen anderen Port als 443 hat, können Sie den Port nicht ändern.

Für Private Cloud-Releases 4.16.01 bis 4.17.05: Beim Erstellen einer virtuellen Hosts angeben, geben Sie den vom virtuellen Host verwendeten Routerport an. Beispiel: Port 9001. Standardmäßig wird der Router als Benutzer „apigee“ ausgeführt die keinen Zugriff auf in der Regel Port 1024 und niedriger. Wenn Sie einen virtuellen Host erstellen möchten der den Router an einen geschützten Port bindet, müssen Sie ihn so konfigurieren, dass er als Nutzer mit Zugriff auf diese Ports. Weitere Informationen finden Sie unter Einrichten eines virtuellen Hosts für mehr.

Für Private Cloud-Releases vor 4.16.01: Ein Router kann auf nur eine HTTPS-Verbindung pro virtuellem Host an einem bestimmten Port mit dem angegebenen Zertifikat. Daher können mehrere virtuelle Hosts bei TLS-Beendigung nicht dieselbe Portnummer verwenden erfolgt auf dem Router am angegebenen Port.

Keine Ja
BaseUrl Überschreibt die von der Edge-Benutzeroberfläche angezeigte URL für einen API-Proxy, der auf dem virtuellen Host. Nützlich, wenn vor den Edge-Routern ein externer Load-Balancer vorhanden ist. Weitere Informationen finden Sie unter TLS konfigurieren Zugriff auf eine API für die Private Cloud.

Der Wert von BaseUrl muss das Protokoll enthalten (d.h. „http://“ oder „https://“).

Keine Nein
OCSPStapling

Ein OCSP-Client (Online Certificate Status Protocol) sendet einen Status Anfrage an einen OCSP-Antwortdienst, um festzustellen, ob das TLS-Zertifikat gültig ist. Die Antwort gibt an, ob das TLS-Zertifikat gültig und nicht widerrufen ist.

Wenn diese Option aktiviert ist, wird Edge beim OCSP-Stapling als TLS-Server für One-Way-TLS zugelassen. um den OCSP-Antwortdienst direkt abzufragen und die Antwort dann im Cache zu speichern. Edge gibt diese Antwort dann an den TLS-Client zurück oder heftet sie im Rahmen des TLS-Handshakes. Weitere Informationen finden Sie im Hilfeartikel OCSP-Stapling auf dem Server aktivieren. finden Sie weitere Informationen.

TLS muss aktiviert sein, um OCSP-Stapling zu aktivieren. Zum Aktivieren on festlegen. Der Standardwert ist off.

deaktiviert Nein
HostAliases
HostAlias

Der öffentlich sichtbare DNS-Name des virtuellen Hosts auf dem Router, optional mit dem Portnummer. Die Kombination aus Host-Alias-Name und Portnummer für den virtuellen Host muss für alle virtuellen Hosts in der Edge-Installation eindeutig sein. Das bedeutet, dass mehrere virtuelle Hosts können dieselbe Portnummer verwenden, wenn sie unterschiedliche Host-Aliasse haben.

Sie müssen einen DNS-Eintrag und einen CNAME-Eintrag erstellen, die mit dem Host-Alias und dem Host übereinstimmen. Alias muss mit dem String übereinstimmen, den der Client im Host-Header übergibt.

Die Portnummer in HostAlias ist optional. Wenn Sie den Port als Teil des Host-Alias an, müssen Sie ihn auch mithilfe der Methode <Port>-Element. Sie können auch zwei HostAlias-Elemente angeben, eine mit und eine ohne Portnummer.

Sie können mehrere HostAlias-Definitionen haben in derselben virtuellen Hostdefinition, die mehreren DNS-Einträgen für die virtueller Host, aber nicht für mehrere Ports. Wenn Sie mehrere Ports benötigen, erstellen Sie virtuelle Host-Definitionen mit verschiedenen Ports.

Sie können das Zeichen „*“ Platzhalterzeichen im Hostalias. Das „*“ kann ein Platzhalterzeichen dürfen nur am Anfang (vor dem ersten „.“) des Host-Alias stehen und nicht mit anderen Zeichen vermischt werden. Beispiel: *.example.com Das TLS-Zertifikat für den virtuellen Host muss eine übereinstimmender Platzhalter im CN-Namen des Zertifikats. Beispiel: *.example.com. Mit einem Platzhalter in einem virtuellen Host-Alias API-Proxys verarbeiten Aufrufe, die an mehrere Sub-Domains wie alpha.example.com, beta.example.com oder live.example.com Mit einem Platzhalter-Alias können Sie außerdem weniger virtuelle Hosts pro Umgebung, um im Produkt , da ein virtueller Host mit einem Platzhalter nur als ein virtueller Host zählt.

Für die Cloud: Wenn Sie einen vorhandenen virtuellen Host haben, der einen anderen Port verwendet als 443 ist, können Sie kein Host-Alias hinzufügen oder entfernen.

Für Private Cloud: Wenn Sie den Host-Alias über die IP-Adresse festlegen Ihrer Router und keine DNS-Einträge, fügen Sie für jeden Router einen separaten Router und geben Sie die IP-Adresse jedes Routers und den Port des virtuellen Hosts an.

Keine Ja
Schnittstellen Nur für Edge for Private Cloud verfügbar.
Schnittstelle

Gibt die Netzwerkschnittstellen an, an die port gebunden werden soll. Wenn Sie Wenn Sie dieses Element weglassen, wird der Port an alle Schnittstellen gebunden.

So geben Sie beispielsweise an, dass der Port nur an en0 gebunden werden soll:

<Interfaces>
  <Interface>en0</Interface>
</Interfaces>

Führen Sie den Befehl „ifconfig -a“ aus, um die in Ihrem System verfügbaren Schnittstellen zu ermitteln. .

Keine Alle Benutzeroberflächen
RetryOptions Verfügbar für Edge Cloud und für Private Cloud 4.18.01 sowie später ansehen.
RetryOption

Konfigurieren Sie, wie der Router auf diesen virtuellen Host reagiert, wenn der Message Processor

Mit <RetryOption> können Sie mehrere Werte angeben. Gültige Werte umfassen:

off Deaktiviert den Wiederholungsversuch und der virtuelle Host gibt bei einer Anfrage einen Fehlercode zurück.
http_599 (Standardeinstellung) Wenn der Router eine HTTP 599-Antwort von der Nachricht erhält, -Prozessors, leitet der Router die Anfrage an den nächsten Message Processor weiter.

HTTP 599 ist ein spezieller Antwortcode, der von einer Nachricht generiert wird Prozessor beim Herunterfahren. Der Message Processor versucht, auf vorhandene Anfragen, aber auf neue Anfragen antwortet er mit HTTP 599, um den Router, um die Anfrage beim nächsten Message Processor zu wiederholen.

error Wenn beim Herstellen einer Verbindung mit dem Message Processor ein Fehler aufgetreten ist, oder den Antwort-Header auslesen, wird der Router vom Router leitet die Anfrage an den nächsten Message Processor weiter.
timeout Wenn beim Herstellen einer Verbindung mit dem Message Processor eine Zeitüberschreitung auftritt, oder den Antwort-Header auslesen, wird der Router vom Router leitet die Anfrage an den nächsten Message Processor weiter.
invalid_header Wenn der Message Processor eine leere oder ungültige Antwort zurückgegeben hat, leitet die Anfrage an den nächsten Message Processor weiter.
http_XXX Wenn der Message Processor eine Antwort mit HTTP Code XXX, leitet der Router die Anfrage an die nächste Nachricht weiter. Prozessor.

Wenn Sie mehrere Werte angeben, verwendet der Router ein logisches ODER, um sie zu kombinieren.

Beispiel:

<RetryOptions>
  <RetryOption>http_599</RetryOption>
  <RetryOption>error</RetryOption>
  <RetryOption>timeout</RetryOption>
  <RetryOption>invalid_header</RetryOption>
</RetryOptions>
ListenOptions Verfügbar für Private Cloud 4.18.01 und höher und für Edge Cloud durch Senden einer Anfrage an den Apigee Edge-Support.
ListenOption

Wenn Sie einen ELB im TCP-Pass-Through-Modus zur Verarbeitung von Anfragen an die Edge Router verwenden, behandelt der Router die IP-Adresse des ELB als Client-IP, die tatsächliche IP-Adresse des Clients. Wenn der Router die tatsächliche Client-IP-Adresse benötigt, proxy_protocol aktivieren auf der ELB, damit die Client-IP im TCP-Paket übergeben wird. Auf dem Router müssen Sie außerdem <ListenOption> auf dem virtuellen Host zu proxy_protocol. Da sich der ELB im TCP-Pass-Through-Modus befindet, beenden Sie normalerweise TLS auf dem Router. Daher konfigurieren Sie in der Regel nur den virtuellen Host für die Verwendung von proxy_protocol auch für die Verwendung von TLS konfigurieren.

Der Standardwert für „<ListenOption>“ ist leer .

Beispiel:

<ListenOptions>
  <ListenOption>proxy_protocol</ListenOption>
</ListenOptions>

Wenn Sie die Einstellung von <ListenOption> später aufheben möchten, aktualisieren Sie die virtuellen Host und lassen Sie das <ListenOptions>-Tag im aktualisieren.

SSLInfo
Aktiviert

Aktiviert One-Way-TLS/SSL. Sie müssen einen Schlüsselspeicher definiert haben, der das Zertifikat und privaten Schlüssel enthält.

Für die Cloud: Sie benötigen ein Zertifikat, das von einer vertrauenswürdigen Entität wie Symantec oder VeriSign signiert wurde. Sie können kein selbst signiertes Zertifikat oder untergeordnete Zertifikate verwenden, die von einer selbst signierten Zertifizierungsstelle signiert wurden.

Für die Cloud: wenn der vorhandene virtuelle Host für die Verwendung eines Ports konfiguriert ist nur 443 auswählen, können Sie die TLS-Einstellung nicht ändern. Das bedeutet, dass Sie die TLS-Einstellung von „aktiviert“ zu „deaktiviert“ oder von „deaktiviert“ zu „aktiviert“.

falsch Nein
ClientAuthEnabled Aktiviert bidirektionales oder Client-TLS zwischen Edge (Server) und der Anwendung (Client), wodurch die Für die Aktivierung von Zwei-Wege-TLS müssen Sie in Edge einen Truststore einrichten, der das Zertifikat vom TLS-Client. falsch Nein
KeyStore

Der Name des Schlüsselspeichers in Edge.

Apigee empfiehlt, dass Sie einen Verweis verwenden, um den Schlüsselspeichernamen anzugeben, damit Sie kann den Schlüsselspeicher ändern, ohne den Router neu starten zu müssen. Weitere Informationen finden Sie unter Optionen für Konfigurieren von TLS.

Keine Ja, wenn „Aktiviert“ auf „wahr“ gesetzt ist
KeyAlias Der Alias, der beim Hochladen des Zertifikats und des privaten Schlüssels in den Schlüsselspeicher angegeben wurde. Ich muss den Aliasnamen buchstäblich angeben. können Sie keine Referenz verwenden. Weitere Informationen finden Sie unter Konfigurationsoptionen TLS. Keine Ja, wenn „Aktiviert“ auf „wahr“ gesetzt ist
TrustStore

Der Name des Truststore in Edge, der das Zertifikat oder die Zertifikatskette enthält wird für Zwei-Wege-TLS verwendet. Erforderlich, wenn <ClientAuthEnabled> „true“ ist.

Apigee empfiehlt, dass Sie zum Angeben des Truststore-Namens eine Referenz verwenden, damit Sie können den Truststore ändern, ohne den Router neu starten zu müssen. Weitere Informationen finden Sie unter Optionen für Konfigurieren von TLS.

Keine Nein
IgnoreValidationErrors

Wenn "true", wird angegeben, dass TLS-Zertifikatfehler ignoriert werden sollen. Dies ähnelt dem „-k“ Option an cURL.

Diese Option ist gültig, wenn Sie TLS für Zielserver und Zielendpunkte konfigurieren. wenn Sie virtuelle Hosts konfigurieren, die 2-Wege-TLS verwenden.

Bei Verwendung mit einem Zielendpunkt/Zielserver, wenn das Back-End-System SNI verwendet und ein Zertifikat zurückgibt mit einem Distinguished Name (DN), der nicht mit dem Hostnamen übereinstimmt, um den Fehler zu ignorieren. Die Verbindung schlägt fehl.

falsch Nein
Chiffren

Nur für Edge for Private Cloud Version 4.15.07 und frühere Versionen.

Gibt die vom virtuellen Host unterstützten Chiffren an. Wenn keine Chiffren angegeben sind, gilt: sind alle für die JVM verfügbaren Chiffren zulässig.

Fügen Sie die folgenden Elemente hinzu, um Chiffren einzuschränken:

<Ciphers>
  <Cipher>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</Cipher>
  <Cipher>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</Cipher>
</Ciphers>
Alle werden von der JVM unterstützt Nein
Protokolle

Nur für Edge for Private Cloud Version 4.15.07 und frühere Versionen.

Gibt die vom virtuellen Host unterstützten Protokolle an. Sind keine Protokolle angegeben, sind alle für die JVM verfügbaren Protokolle zulässig.

Fügen Sie die folgenden Elemente hinzu, um Protokolle einzuschränken:

<Protocols>
  <Protocol>TLSv1</Protocol>
  <Protocol>TLSv1.2</Protocol>
  <Protocol>SSLv2Hello</Protocol>
</Protocols>
Alle werden von der JVM unterstützt Nein
UseBuiltInFreeTrialCert Nur für Edge Cloud verfügbar.
UseBuiltInFreeTrialCert

Wenn Sie ein kostenpflichtiges Edge for Cloud-Konto und noch kein TLS-Zertifikat und keinen TLS-Schlüssel haben, können Sie einen virtuellen Host erstellen, der das Zertifikat und den Schlüssel der kostenlosen Apigee-Testversion verwendet. Das bedeutet, dass Sie ohne vorher einen Schlüsselspeicher zu erstellen.

Das kostenlose Apigee-Testzertifikat ist für eine Domain von *.apigee.net definiert. Daher entspricht der Parameter <HostAlias> des virtuellen Hosts muss ebenfalls das Format *.apigee.net haben.

Weitere Informationen finden Sie unter Virtuellen Host definieren die das Zertifikat und den Schlüssel der kostenlosen Apigee-Testversion verwendet.

falsch Nein
PropagateTLSInformation Nur in der Alphaversion für Edge Cloud verfügbar.
ConnectionProperties

Aktiviert die Erfassung von TLS-Verbindungsinformationen durch Edge. Diese Informationen stehen dann als Flussvariablen in einem API-Proxy zur Verfügung. Siehe Zugreifen auf TLS-Verbindungsinformationen in einem API-Proxy finden Sie weitere Informationen.

falsch Nein
ClientProperties

Aktiviert die Erfassung von Clientzertifikatdetails, die von Edge in Zwei-Wege-TLS erfasst wurden. Diese Informationen stehen dann als Flussvariablen in einem API-Proxy zur Verfügung. Siehe Zugreifen auf TLS-Verbindungsinformationen in einem API-Proxy finden Sie weitere Informationen.

falsch Nein
Properties Verfügbar für Edge Cloud und für Private Cloud 4.17.01 sowie später ansehen.
proxy_read_timeout

Legt die Zeitüberschreitungsdauer in Sekunden zwischen Message Processors und dem Router fest. Die Der Router unterbricht die Verbindung und gibt eine HTTP 504-Antwort zurück, wenn keine Antwort vom Message Processor vor Ablauf dieser Dauer.

Der Wert für „proxy_read_timeout“ muss größer als der Zielwert für die Zeitüberschreitung sein durch den Message Processor. Dadurch wird sichergestellt, dass der Router keine Zeitüberschreitung vor Ablauf der Der Message Processor hatte Zeit, eine Antwort zurückzugeben. Das standardmäßige Zielzeitlimit für die Der Message Processor beträgt 55 Sekunden, 55.000 Millisekunden, gemäß der Definition conf_http_HTTPTransport.io.timeout.millis-Token für die Nachricht Prozessor.

57 Nein
keepalive_timeout

Legt das Zeitlimit in Sekunden zwischen dem Client und dem Router fest, wenn der Client stellt eine Anfrage, die den Keep-Alive-Header enthält. Der Router hält die Verbindung offen. bis die Dauer abgelaufen ist.

Der Router schließt die Verbindung nicht, wenn er gerade auf eine Antwort wartet vom Message Processor. Das Zeitlimit beginnt erst, nachdem der Router die Antwort zurückgegeben hat an die Kundschaft.

65 Nein
ssl_ciphers

Legt die vom virtuellen Host unterstützten Chiffren fest und überschreibt die Standardchiffren, die für den Router.

Geben Sie eine durch Doppelpunkte getrennte Liste von Chiffren im folgenden Format an:

<Property name="ssl_ciphers">HIGH:!aNULL:!MD5:!DH+3DES:!kEDH;</Property>

Informationen zur Syntax und zu den Werten, die für dieses Token zulässig sind, finden Sie unter https://www.openssl.org/docs/man1.0.2/man1/ciphers.html. Beachten Sie, dass dieses Token die Verschlüsselungsnamen von OpenSSL wie AES128-SHA256 und nicht den Java/JSSE-Chiffrennamen wie TLS_RSA_WITH_AES_128_CBC_SHA256.

HOCH:!aNULL:

!MD5:

!DH+3DES:

!kEDH

Nein
ssl_protocols

Nur für Edge for Private Cloud verfügbar.

Legt die vom virtuellen Host unterstützten TLS-Protokolle als durch Leerzeichen getrennte Liste fest. die am Router festgelegten Standardprotokolle überschreiben.

Hinweis: Wenn zwei virtuelle Hosts denselben Port nutzen, müssen sie ssl_protocols auf dieselben Protokolle. Virtuelle Hosts mit demselben Port müssen also unterstützen genau die gleichen Protokolle.

Geben Sie eine durch Leerzeichen getrennte Liste von TLS-Protokollen im folgenden Format an:

<Property name="ssl_protocols">TLSv1 TLSv1.2</Property>
TLSv1 TLSv1.1 TLSv1.2 Nein
proxy_request_buffering

Aktiviert (on) oder deaktiviert (aus) die Zwischenspeicherung des Anfragetexts. Wenn die Pufferung aktiviert ist, Der Router puffert den gesamten Anfragetext, bevor er an den Message Processor gesendet wird. Wenn liegt ein Fehler vor, kann der Router es mit einem anderen Message Processor versuchen.

Wenn diese Option deaktiviert ist, ist die Zwischenspeicherung deaktiviert und der Anfragetext wird an den Message Processor gesendet. bei Empfang. Tritt ein Fehler auf, wiederholt der Router die an einen anderen Message Processor gesendet.

am Nein
proxy_buffering Aktiviert (on) oder deaktiviert (aus) die Zwischenspeicherung der Antwort. Wenn die Pufferung aktiviert ist, Der Router puffert die Antwort. Wenn die Zwischenspeicherung deaktiviert ist, wird die Antwort an den Client übergeben. synchron, also sofort, wenn sie vom Router empfangen werden. am Nein