Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu
Apigee X. info
In Edge verarbeitet ein Router den gesamten eingehenden API-Traffic. Das bedeutet, dass alle HTTP- und HTTPS Anfragen an einen API-Proxy zuerst von einem Edge-Router verarbeitet werden.
Mit einem virtuellen Host können Sie mehrere Domainnamen auf einem Server hosten. Für Edge entspricht der Server einem Edge-Router. Wenn Sie mehrere virtuelle Hosts auf einem Router definieren, kann der Router API-Anfragen an mehrere Domainnamen verarbeiten.
Ein virtueller Host in Edge definiert das Zugriffsprotokoll (HTTP oder HTTPS), einen offenen Router-Port und einen Host Alias. Der Host-Alias ist in der Regel der DNS-Domainname, der der IP-Adresse des Routers zugeordnet ist.
Die folgende Abbildung zeigt beispielsweise einen Router mit zwei Definitionen für virtuelle Hosts:

Der erste virtuelle Host verarbeitet HTTPS-Anfragen an die Domain domainName1 und der zweite HTTP-Anfragen an domainName2.
Bei einer Anfrage an einen API-Proxy vergleicht der Router den Host Header der eingehenden Anfrage mit der
Liste der Host-Aliasse, die von allen virtuellen Hosts definiert wurden, um zu bestimmen, welcher virtuelle
Host die Anfrage verarbeitet.
Definitionen für virtuelle Hosts
Virtuelle Hosts enthalten die folgenden Informationen:
- Der interne Name des virtuellen Hosts. Mit diesem Namen verweisen Sie in Ihren API-Proxys auf den virtuellen Host und konfigurieren ihn.
- Der Host-Alias des virtuellen Hosts. In der Regel ist der Host-Alias der DNS
Domainname, der der IP-Adresse auf dem Router zugeordnet ist. Der
HostHeader von API-Proxy-Anfragen muss den Host-Alias des virtuellen Hosts enthalten. - Ein offener Port auf dem Router.
- Ob TLS (HTTPS-Zugriff) aktiviert ist oder nicht (HTTP-Zugriff).
Wenn Sie einen virtuellen Host erstellen, geben Sie beispielsweise die folgenden Informationen an:
- Name = myvhost
- Host-Alias = apis.acme.com
- Port = 443
- TLS ist aktiviert
Basierend auf der oben genannten Einstellung für den virtuellen Host hat eine Anfrage an einen API-Proxy das folgende Format:
https://apis.acme.com/{proxy-base-path}/{resource-path}Dabei gilt:
- {proxy-base-path} wird beim Erstellen eines API-Proxys definiert und ist für jeden API-Proxy eindeutig.
Beispiel:
https://apis.acme.com/characters
- {resource-path} ist der Pfad zu einer Ressource, auf die über den API-Proxy zugegriffen werden kann. Beispiel:
https://apis.acme.com/characters/coyote https://apis.acme.com/characters/roadrunner
Virtuelle Hosts in Edge for the Cloud
Jede Edge-Organisation enthält automatisch zwei Umgebungen (test
und prod), zwei virtuelle Hosts in jeder Umgebung (default und secure),
und DNS-Einträge für jeden Host-Alias.
Der Host-Alias jedes von Apigee bereitgestellten virtuellen Hosts enthält den Namen der Organisation und Umgebung, wie in der folgenden Tabelle dargestellt:
| Umgebung | Name des virtuellen Hosts | Host-Alias | Port | TLS aktiviert |
|---|---|---|---|---|
| prod | Standardeinstellung | {org-name}-prod.apigee.net |
80 | Nein |
| sicher | {org-name}-prod.apigee.net |
443 | Ja | |
| Test | Standardeinstellung | {org-name}-test.apigee.net |
80 | Nein |
| sicher | {org-name}-test.apigee.net |
443 | Ja |
Der Standarddomainname einer Organisation mit dem Namen "myorg"
in der Umgebung prod ist beispielsweise "myorg-prod.apigee.net".
Wenn Sie auf einen API-Proxy in dieser Organisation zugreifen möchten, verwenden Sie daher eine URL im folgenden Format:
http://myorg-prod.apigee.net/{proxy-base-path}/{resource-path}
https://myorg-prod.apigee.net/{proxy-base-path}/{resource-path}Apigee-Abo-Modelle: Ein Domainname mit „apigee.net“ ist möglicherweise nicht das, was Sie Ihren Kunden präsentieren möchten. Sie können einen DNS-Eintrag und einen CNAME-Eintrag verwenden, um einen Domainnamen Ihrer Organisation in Edge zuzuordnen. Außerdem müssen Sie einen virtuellen Host erstellen, bei dem der Host-Alias auf diesen Domainnamen festgelegt ist. So können Entwickler über eine für Ihr Unternehmen spezifische Domain auf Ihre API zugreifen.
Hier ein Beispiel für eine benutzerdefinierte Domain in Edge:
https://apis.acme.com/{proxy-base-path}/{resource-path}Virtuelle Hosts in Edge for Private Cloud
Wenn Sie Apigee Edge for Private Cloud installieren, werden keine Standardorganisationen, Umgebungen oder virtuellen Hosts für Sie erstellt. Nach Abschluss der Edge-Installation besteht Ihre erste Aktion in der Regel darin, über den Onboarding-Prozess eine Organisation, eine Umgebung und einen virtuellen Host zu erstellen.
Führen Sie dazu den folgenden Befehl auf dem Edge-Verwaltungsserverknoten aus:
/opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile
Dabei enthält configFile die Informationen, die zum Erstellen eines Nutzers, einer Organisation, einer Umgebung und eines virtuellen Hosts erforderlich sind.
Beispiel: Sie erstellen Folgendes:
- Einen Nutzer Ihrer Wahl, der als Organisationsadministrator fungiert
- Eine Organisation mit dem Namen
example - Eine Umgebung in der Organisation mit dem Namen
prod - Einen virtuellen Host in der Umgebung mit dem Namen
default, der HTTP-Zugriff auf Port 9001 ermöglicht - Einen Host-Alias des DNS-Namens, der für den Zugriff auf den Router verwendet wird, oder die IP-Adresse des Routers und
den Port des virtuellen Hosts im Format
IP:9001.
Sie können Ihrer lokalen Version von Edge später beliebig viele Organisationen, Umgebungen und virtuelle Hosts hinzufügen. Weitere Informationen finden Sie unter:
Virtuelle Hosts werden auf dem Edge-Router geöffnet. Sie müssen daher dafür sorgen, dass der Port, den Sie für den virtuellen Host angeben, auf dem Router geöffnet ist. Mit einem Befehl im folgenden Format können Sie einen Port öffnen:
iptables -A INPUT -m state --state NEW -m tcp -p tcp --dport 9001 -j ACCEPT --verbose
Nachdem Sie diesen Befehl ausgeführt haben, können Sie über eine URL im folgenden Format auf Ihre APIs zugreifen:
http://<router-ip>:9001/{proxy-base-path}/{resource-path}In der Regel veröffentlichen Sie Ihre APIs nicht mit einer IP-Adresse und einer Portnummer für Kunden. Stattdessen definieren Sie einen DNS-Eintrag für den Router und den Port. Beispiel:
http://myAPI.myCo.com/{proxy-base-path}/{resource-path}Wenn Sie den DNS-Eintrag definieren, müssen Sie auch einen virtuellen Host mit einem Host-Alias erstellen, der mit dem Domainnamen des DNS-Eintrags übereinstimmt. Im obigen Beispiel würden Sie beim Erstellen des virtuellen Hosts einen Host-Alias von „myAPI.myCo.com“ angeben.
Host-Aliasse und DNS-Namen
Eine Eigenschaft, die Sie für einen virtuellen Host festlegen, ist der Host-Alias. Der Host-Alias ist in der Regel der DNS-Name des virtuellen Hosts. Wie Sie den Host-Alias festlegen, hängt von Ihrer Art der Edge-Installation ab: Cloud oder Private Cloud.
Host-Aliasse und DNS-Namen in Edge for the Cloud
Wenn Sie in Edge for the Cloud zum ersten Mal eine Edge-Organisation erstellen, erstellt Apigee automatisch
zwei Umgebungen (test
und prod), zwei virtuelle Hosts in
jeder Umgebung (default und secure) und DNS-Einträge für jeden
virtuellen Host.
Der Host-Alias der virtuellen Hosts enthält den Namen der Organisation und der Umgebung. Eine Anfrage über einen virtuellen Host hat daher das folgende Format:
http://{org-name}-prod.apigee.net/{proxy-base-path}/{resource-path}https://{org-name}-prod.apigee.net/{proxy-base-path}/{resource-path}http://{org-name}-test.apigee.net/{proxy-base-path}/{resource-path}https://{org-name}-test.apigee.net/{proxy-base-path}/{resource-path}
In der Regel möchten Sie virtuelle Hosts erstellen, die Ihren Domainnamen verwenden, anstatt die
Standard apigee.net Domain zu verwenden. Dazu müssen Sie zuerst einen eigenen DNS-Eintrag und einen CNAME-Eintrag erstellen.
Die folgende Abbildung zeigt eine typische Konfiguration für die Verarbeitung einer API-Anfrage durch Edge:

In diesem Beispiel gilt Folgendes:
- api.acme.com ist der gewünschte Domainname.
- Sie definieren einen DNS-Eintrag und einen CNAME-Eintrag, um api.acme.com auf acme-prod.apigee.net zu verweisen.
- Die Anfrage enthält den
HostHeader, mit dem der Router den virtuellen Host bestimmt, der die Anfrage verarbeitet.
In diesem Beispiel geben Sie die folgenden Informationen in einer Definition für virtuelle Hosts an:
- Name = myvhost
- Host-Alias = apis.acme.com
- Port = 443
- TLS-Zugriff aktivieren
Weitere Informationen finden Sie unter Virtuelle Hosts für die Cloud konfigurieren.
Host-Aliasse und DNS-Namen in Edge for Private Cloud
Wie bei Edge for the Cloud erstellen Sie virtuelle Hosts, die Ihren eigenen Domainnamen für den Host Alias verwenden. Anschließend erstellen Sie einen eigenen DNS-Eintrag und einen CNAME-Eintrag, um auf diese virtuellen Hosts zuzugreifen.
Einer der Unterschiede zwischen Cloud und Private Cloud besteht darin, dass Apigee in der Cloud automatisch DNS-Namen für Ihre Organisationen im folgenden Format erstellt hat:
- Name=default:
http://{org-name}-{env-name}.apigee.net(Router-Port 80) - Name=secure:
https://{org-name}-{env-name}.apigee.net(Router-Port 443)
In Edge for Private Cloud müssen Sie die DNS-Einträge für die IP-Adresse und den Port Ihres Routers erstellen.
Beispiel: Sie geben diese Informationen in einer Definition für virtuelle Hosts an:
- Name = myvhost
- Host-Alias = apis.acme.com
- Port = 9001
- TLS-Zugriff aktivieren
Die folgende Abbildung zeigt eine typische Konfiguration für die Verarbeitung einer API-Anfrage durch Edge:

In diesem Beispiel gilt Folgendes:
- api.acme.com ist der gewünschte Domainname.
- Sie definieren einen DNS-Eintrag und einen CNAME-Eintrag, um api.acme.com auf die IP Adresse und den Port des Routers zu verweisen.
- Die Anfrage enthält den
HostHeader, mit dem der Router den virtuellen Host bestimmt, der die Anfrage verarbeitet.
Weitere Informationen finden Sie unter Virtuelle Hosts für die Private Cloud konfigurieren.
Host-Aliasse und Platzhalter
Sie können das Platzhalterzeichen „*“ in den Host-Alias einfügen. Das Platzhalterzeichen „*“ darf nur am Anfang des Host-Alias stehen (vor dem ersten „.“) und kann nicht mit anderen Zeichen kombiniert werden.
Das folgende Beispiel zeigt einen gültigen Host-Alias mit einem Platzhalter:
*.example.com
Die folgenden Beispiele sind ungültig:
www.*.example.com w*.example.com
Wenn Sie einen Platzhalter in einem virtuellen Host-Alias verwenden, können
API-Proxys Aufrufe verarbeiten, die an mehrere Subdomains gerichtet sind, z. B.
alpha.example.com, beta.example.com oder
live.example.com. Wenn Sie einen Platzhalter-Alias verwenden, benötigen Sie außerdem weniger virtuelle
Hosts pro Umgebung, um die Produkt
Limits einzuhalten, da ein virtueller Host mit einem Platzhalter nur als ein virtueller Host zählt.
Das TLS-Zertifikat für den virtuellen Host muss einen übereinstimmenden Platzhalter im CN-Namen des Zertifikats haben.
Beispiel: *.example.com.
Eigenschaften virtueller Hosts
In Edge wird ein virtueller Host durch ein XML-Objekt dargestellt. Das folgende XML-Objekt definiert beispielsweise einen virtuellen Host:
<VirtualHost name="vhostName">
<HostAliases>
<HostAlias>hostAlias</HostAlias>
</HostAliases>
<Interfaces>
<!-- Private Cloud only -->
<Interface>interfaceName</Interface>
<Port>portNumber</Port>
<BaseURL>http://myCo.com<</BaseUrl>
<OCSPStapling>off</OCSPStapling>
<RetryOptions/>
<SSLInfo>
<Enabled>trueFalse</Enabled>
<ClientAuthEnabled>trueFalse</ClientAuthEnabled>
<KeyStore>ref://keystoreRef</KeyStore>
<KeyAlias>keyAlias</KeyAlias>
<TrustStore>ref://truststoreRef</TrustStore>
<IgnoreValidationErrors>trueFalse</IgnoreValidationErrors>
</SSLInfo>
<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>
<Property name="ssl_protocols">protocolList</Property>
<Property name="ssl_ciphers">cipherList</Property>
</Properties>
</VirtualHost>Die Liste der Eigenschaften, die Sie festlegen können, hängt davon ab, ob Sie Edge for the Cloud oder Edge for Private Cloud verwenden. Wenn Sie Edge for Private Cloud verwenden, hängt die Liste der verfügbaren Eigenschaften auch von Ihrer Edge-Version ab. Eine vollständige Beschreibung aller Eigenschaften eines virtuellen Hosts finden Sie unter Referenz zu Eigenschaften virtueller Hosts.
Weitere Informationen zum Erstellen virtueller Hosts für Ihre spezifische Edge-Version finden Sie unter: