API-Gateway erstellen

1. Wählen Sie auf der Listenseite Gateways die Option Gateway erstellen aus. Wenn Sie Hilfe beim Suchen der Listenseite benötigen, lesen Sie API-Gateways auflisten.

2. Geben Sie die folgenden Werte für das neue API-Gateway an:

   • Name: Der Name des API-Gateways. Vermeiden Sie die Eingabe von vertraulichen Informationen.
   • Compartment: Das Compartment, in dem das API-Gateway erstellt werden soll.
   • Zertifikat: Das TLS-Zertifikat, das das API-Gateway verwendet. Das von Ihnen ausgewählte TLS-Zertifikat bestimmt den Domainnamen des API-Gateways.
     • Standard (*.oci.customer-oci.com) (falls angezeigt): Wählen Sie diese Option aus, wenn der Domainname automatisch für Sie generiert werden soll und das API-Gateway ein Standard-TLS-Zertifikat verwenden soll, das vom API Gateway-Service abgerufen wird. Der generierte Standarddomainname enthält eine zufällige Zeichenfolge gefolgt von .apigateway.<region-identifier>.oci.customer-oci.com. Beispiel: laksjd.apigateway.us-phoenix-1.oci.customer-oci.com. Diese Option ist nur verfügbar, wenn Ihr Mandant in der Realm OC1 vorhanden ist.
     • Kategorie Certificates-Service (falls angezeigt): Wählen Sie eine vorhandene Zertifikats-Service-Zertifikatsressource aus, die die Details des benutzerdefinierten TLS-Zertifikats enthält, das das API-Gateway verwenden soll. Das API-Gateway verwendet einen benutzerdefinierten Domainnamen, der mit dem ausgewählten Zertifikat verknüpft ist. Diese Kategorie wird nur angezeigt, wenn Zertifikatressourcen des Certificates-Service im ausgewählten Zertifikat-Compartment verfügbar sind.
     • Kategorie API-Gatewayzertifikate (falls angezeigt): Wählen Sie eine vorhandene API-Gateway-Zertifikatsressource aus, die Details des benutzerdefinierten TLS-Zertifikats enthält, das das API-Gateway verwenden soll. Das API-Gateway verwendet einen benutzerdefinierten Domainnamen, der mit dem ausgewählten Zertifikat verknüpft ist. Diese Kategorie wird nur angezeigt, wenn API-Gateway-Zertifikatsressourcen im ausgewählten Zertifikat-Compartment verfügbar sind.

     Siehe Benutzerdefinierte Domains und TLS-Zertifikate einrichten.

     Hinweis
     
     

     Wir empfehlen die Verwendung eines benutzerdefinierten TLS-Zertifikats für öffentliche oder Produktionssysteme. Wir empfehlen, ein vom API Gateway-Service abgerufenes TLS-Standardzertifikat nur für private oder Nicht-Produktionssysteme zu verwenden (z.B. für Entwicklung und Test).

   • Typ: Den Typ des zu erstellenden API-Gateways.
     • Wählen Sie Privat aus, wenn Sie nur möchten, dass das API-Gateway (und die darin bereitgestellten APIs) über Ressourcen im selben privaten Netzwerk (VCN) oder über Ressourcen in anderen privaten oder On-Premise-Netzwerken mit diesem privaten Netzwerk zugänglich ist.
     • Wählen Sie Öffentlich aus, wenn das API-Gateway (und die darin bereitgestellten APIs) öffentlich zugänglich sein soll. Öffentliche API-Gateways können über das Internet erreicht werden, sofern ein Internetgateway im VCN des API-Gateways vorhanden ist.
   • Virtuelles Cloud-Netzwerk: Das VCN, in dem das API-Gateway aus der Liste der VCNs im angegebenen Compartment erstellt werden soll. Das VCN kann sich im selben Compartment wie das API-Gateway befinden, muss es jedoch nicht sein.
   • Subnetz: Das öffentliche oder private regionale Subnetz, in dem das API-Gateway aus der Liste der Subnetze im angegebenen Compartment erstellt werden soll. Wenn Sie ein öffentliches API-Gateway erstellen möchten, müssen Sie ein öffentliches regionales Subnetz angeben.

     Beachten Sie, dass API Gateway auf Port 443 kommuniziert, der standardmäßig nicht geöffnet ist. Sie müssen eine neue zustandsbehaftete Ingress-Sicherheitsregel für das regionale Subnetz hinzufügen (entweder in einer Sicherheitsliste oder in einer Netzwerksicherheitsgruppe), um Traffic auf Port 443 zuzulassen. For the properties of the ingress security rule, see Create a VCN to Use with API Gateway, If One Doesn't Already Exist.

   • Netzwerksicherheitsgruppen aktivieren: Wählen Sie diese Option aus, um den Zugriff auf und vom API-Gateway mit Sicherheitsregeln zu kontrollieren, die für eine oder mehrere von Ihnen angegebene Netzwerksicherheitsgruppen (NSGs) definiert sind (maximal fünf Netzwerksicherheitsgruppen). Sie können Sicherheitsregeln verwenden, die für NSGs definiert sind, anstatt oder zusätzlich zu den für Sicherheitslisten definierten. NSGs können zu demselben Compartment wie das neue API-Gateway gehören, müssen dies jedoch nicht. Siehe Netzwerksicherheitsgruppen.
3. Wählen Sie optional Erweiterte Optionen, und geben Sie die folgenden Werte an:
   • Antwort-Caching: Optionen zum Aktivieren und Konfigurieren von Antwort-Caching für das API-Gateway, um die Performance zu verbessern und die Last für Backend-Services zu reduzieren. Siehe Antworten zur Performanceverbesserung cachen.
   • Zertifizierungsstellen: Eine oder mehrere CA-Ressourcen oder CA-Bundle-Ressourcen, die als benutzerdefinierte CAs und benutzerdefinierte CA-Bundles (zusätzlich zum Standard-CA-Bundle) zum Truststore des API-Gateways hinzugefügt werden sollen. Benutzerdefinierte CAs und benutzerdefinierte CA-Bundles werden verwendet, um TLS-Zertifikate zu prüfen, die von API-Clients und Backend-Services bereitgestellt werden. Siehe Truststores für TLS-Zertifikatsverifizierung anpassen.
   • Tags: Wenn Sie über Berechtigungen zum Erstellen von Ressourcen verfügen, können Sie auch Freiformtags auf diese Ressource anwenden. Um ein definiertes Tag anzuwenden, benötigen Sie Die Berechtigungen zum Verwenden des Tag-Namespace. Weitere Informationen zu Tagging finden Sie unter Ressourcentags. Wenn Sie nicht sicher sind, ob Tags angewendet werden sollen, überspringen Sie diese Option, oder fragen Sie einen Administrator. Sie können Tags später anwenden.
     Hinweis
     
     Wenn Sie ein definiertes Tag auf ein API-Gateway anwenden (entweder direkt oder als Tagstandard für ein Compartment) und anschließend die Tagdefinition ändern, kann das API-Gateway einen Status "Nicht erfolgreich" eingeben. Wenden Sie ein definiertes Tag nur dann auf ein API-Gateway an, wenn sich das definierte Tag nicht ändern wird. Wenn Sie nicht sicher sind, ob sich ein definiertes Tag ändert, sollten Sie es nicht auf ein API-Gateway anwenden.

4. Wählen Sie Erstellen aus, um das API-Gateway sofort zu erstellen.

   Das Erstellen des neuen API-Gateways kann einige Minuten dauern. Während der Erstellung wird das API-Gateway mit dem Status "Wird erstellt" angezeigt. Sobald es erfolgreich erstellt wurde, wird das API-Gateway mit dem Status "Aktiv" angezeigt.

   Anstatt das neue API-Gateway sofort zu erstellen, können Sie es später mit Resource Manager und Terraform erstellen. Wählen Sie dazu Als Stack speichern aus, um die Ressourcendefinition als Terraform-Konfiguration zu speichern. Weitere Informationen zum Speichern von Stacks aus Ressourcendefinitionen finden Sie unter Stacks auf der Seite "Ressourcen erstellen" erstellen.

5. Wenn Sie mehr als ein paar Minuten darauf warten, dass das API-Gateway mit dem Status "Aktiv" angezeigt wird (oder wenn die Erstellung des API-Gateways nicht erfolgreich war), führen Sie die folgenden Aktionen aus:

   1. Wählen Sie den Namen des API-Gateways auf der Listenseite Gateways aus, und wählen Sie die Registerkarte Arbeitsanforderungen aus, um einen Überblick über den API-Gatewayerstellungsvorgang anzuzeigen.
   2. Wählen Sie den Vorgang Gateway erstellen aus, um weitere Informationen zum Vorgang anzuzeigen (einschließlich Fehlermeldungen, Logmeldungen und Status der zugehörigen Ressourcen).
   3. Wenn der Vorgang zur Erstellung des API-Gateways fehlgeschlagen war und Sie die Ursache des Problems anhand der Arbeitsanforderungsinformationen nicht diagnostizieren konnten, gehen Sie zu API-Gateway-Fehler beheben.

Nachdem ein API-Gateway erfolgreich erstellt wurde, können Sie eine API darin bereitstellen. Siehe API in einem API-Gateway durch Erstellen eines API-Deployments bereitstellen.