API durch Erstellen eines API-Deployments in einem API-Gateway bereitstellen

So erstellen Sie mit der Konsole ein API-Deployment, während Sie dabei die API-Deployment-Spezifikation in die Dialogfelder der Konsole eingeben:

1. Wählen Sie auf der Listenseite Gateways das API-Gateway aus, auf dem Sie die API bereitstellen möchten. Wenn Sie Hilfe beim Suchen der Listenseite oder des API-Gateways benötigen, finden Sie weitere Informationen unter API-Gateways auflisten.
2. Wählen Sie auf der Seite Gatewaydetails Bereitstellungen aus der Liste Ressourcen und dann Deployment erstellen aus.

3. Wählen Sie Völlig neu, und geben Sie im Abschnitt Basisinformationen Folgendes an:

   • Name: Den Namen des neuen API-Deployments. Vermeiden Sie die Eingabe von vertraulichen Informationen.

   • Pfadpräfix: Einen Pfad, in dem alle Routen bereitgestellt werden sollen, die in der API-Deployment-Spezifikation enthalten sind. Beispiel:

     • /v1
     • /v2
     • /test/20191122

     Beachten Sie, dass das angegebene Deployment-Pfadpräfix:

     • einen Vorwärtsschrägstrich (/ ) vorangestellt haben muss. Es kann nur ein einzelner Vorwärtsschrägstrich verwendet werden
     • mehrere Schrägstriche enthalten kann (sofern diese nicht aufeinander folgen), jedoch nicht mit einem Schrägstrich enden darf
     • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
     • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
     • keine Parameter und Platzhalter enthalten darf

     Wenn ein API-Deployment einen einzelnen Schrägstrich als Deployment-Pfadpräfix aufweist, ist dies das einzige API-Deployment, das für ein bestimmtes API-Gateway zulässig ist. Sie können kein API-Deployment mit einem einzelnen Schrägstrich als Deployment-Pfadpräfix erstellen, wenn bereits ein anderes API-Deployment auf demselben API-Gateway vorhanden ist.

   • Compartment: Das Compartment, in dem das neue API-Deployment erstellt werden soll.

4. (Optional) Geben Sie im Abschnitt API-Anforderungs-Policys optional Anforderungs-Policy-Details an, um Folgendes zu unterstützen:

   • Mutual-TLS: Wählen Sie mTLS aktivieren aus, und geben Sie Details zu einer mTLS-Anforderungs-Policy ein (siehe mTLS-Unterstützung zu API-Deployments hinzufügen).
   • Authentifizierung: Wählen Sie Hinzufügen aus, und geben Sie Details zu einer Authentifizierungsanforderungs-Policy ein (siehe Authentifizierung und Autorisierung zu API-Deployments hinzufügen).
   • CORS: Wählen Sie Hinzufügen aus, und geben Sie Details zu einer CORS-Anforderungs-Policy ein (siehe CORS-Support zu API-Deployments hinzufügen).
   • Ratenbeschränkung: Wählen Sie Hinzufügen aus, und geben Sie Details zu einer Anforderungs-Policy zur Ratenbeschränkung ein (siehe Anzahl von Anforderungen an API-Gateway-Backends begrenzen).

5. (Optional) Geben Sie im Abschnitt API-Logging-Policys optional eine Ausführungslogebene an, um Informationen über die Verarbeitung innerhalb des API-Gateways aufzuzeichnen. Siehe Logging zu API-Deployments hinzufügen.

6. (Optional) Wählen Sie Erweiterte Optionen anzeigen, und geben Sie optional Folgendes an:

   • Tags: Wenn Sie über Berechtigungen zum Erstellen von Ressourcen verfügen, können Sie auf die Ressource auch Freiformtags 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.
7. Wählen Sie Weiter aus, um die Seite Authentifizierung anzuzeigen und Details für eine Authentifizierungsanforderungs-Policy einzugeben:
   • Keine Authentifizierung: Wählen Sie diese Option aus, um nicht authentifizierten Zugriff auf alle Routen im API-Deployment zu erteilen.
   • Einzelne Authentifizierung: Wählen Sie diese Option aus, um alle Authentifizierungsanforderungen an einen einzelnen Authentifizierungsserver weiterzuleiten. Der Authentifizierungsserver kann ein Identitätsprovider sein, der JSON Web Tokens (JWTs) validiert, oder eine Autorisiererfunktion, die Zugriffstoken mit mehreren Argumenten oder einzelnen Argumenten validiert. Weitere Informationen finden Sie unter:
     • Token an Autorisatorfunktionen zum Hinzufügen von Authentifizierung und Autorisierung zu API-Deployments übergeben
     • Token zum Hinzufügen von Authentifizierung und Autorisierung zu API-Deployments validieren
   • Multi-Authentifizierung: Wählen Sie diese Option aus, um Authentifizierungsanforderungen entsprechend der von Ihnen eingegebenen Kontextvariable und Regeln an verschiedene Authentifizierungsserver weiterzuleiten. Weitere Informationen finden Sie unter Mehrere Authentifizierungsserver zu demselben API-Deployment hinzufügen.

   Weitere Informationen finden Sie unter Authentifizierung und Autorisierung zu API-Deployments hinzufügen.

8. Wählen Sie Weiter aus, um Details zu den Routen im API-Deployment einzugeben.

9. Geben Sie im Abschnitt Route 1 die erste Route im API-Deployment an, die einem Backend-Service einen Pfad und eine oder mehrere Methoden zuordnet:

   • Pfad: Einen Pfad zum Backend-Service für API-Aufrufe, die die aufgeführten Methoden verwenden. Beachten Sie, dass der von Ihnen angegebene Routenpfad:

     • relativ zum Deployment-Pfadpräfix ist
     • einen Schrägstrich ( / ) vorangestellt haben muss. Es kann nur ein einzelner Schrägstrich verwendet werden
     • mehrere Schrägstriche enthalten (sofern diese nicht aufeinander folgen) und mit einem Schrägstrich enden kann
     • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
     • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
     • Parameter und Platzhalter enthalten kann (siehe Pfadparameter und Platzhalter zu Routenpfaden hinzufügen)
   • Methoden: Eine oder mehrere Methoden, die vom Backend-Service akzeptiert werden (durch Komma getrennt). Beispiel: GET, PUT.

   • Ein einzelnes Backend hinzufügen oder Mehrere Backends hinzufügen: Gibt an, ob alle Anforderungen an dasselbe Backend weitergeleitet oder Anforderungen entsprechend der eingegebenen Kontextvariable und Regeln an verschiedene Backends weitergeleitet werden sollen.

     Bei diesen Anweisungen wird davon ausgegangen, dass Sie ein einzelnes Backend verwenden möchten. Wählen Sie daher Ein einzelnes Backend hinzufügen aus. Wenn Sie alternativ andere Backends verwenden möchten, wählen Sie Mehrere Backends hinzufügen aus, und befolgen Sie die Anweisungen unter Dynamische Backend-Auswahl mit der Konsole zu einer API-Deployment-Spezifikation hinzufügen.

   • Backend-Typ: Den Typ des Backend-Service. Wählen Sie dazu eine der folgenden Optionen:
     • HTTP: Bei einem HTTP-Backend müssen Sie auch eine URL und Timeoutdetails angeben. Außerdem müssen Sie angeben, ob die SSL-Überprüfung deaktiviert werden soll (siehe HTTP- oder HTTPS-URL als API-Gateway-Backend hinzufügen).
     • Oracle Functions: Wenn Sie ein OCI Functions-Backend verwenden, müssen Sie auch die Anwendung und Funktion angeben (siehe Funktion in OCI Functions als API-Gateway-Backend hinzufügen).
     • Standardantwort: Bei einem Standardantwort-Backend müssen Sie auch den HTTP-Statuscode, den Inhalt im Hauptteil der Antwort und mindestens ein HTTP-Headerfeld angeben (siehe Standardantworten als API-Gateway-Backend hinzufügen).
10. (Optional) Wählen Sie Weitere Route aus, um Details zusätzlicher Routen einzugeben.
11. Wählen Sie Weiter aus, um die Details zu prüfen, die Sie für das neue API-Deployment eingegeben haben.

12. Wählen Sie Erstellen aus, um das neue API-Deployment zu erstellen.

    Es kann einige Minuten dauern, bis das neue API-Deployment erstellt wird. Während der Erstellung wird das API-Deployment auf der Seite Gatewaydetails mit dem Status "Wird erstellt" angezeigt. Sobald es erfolgreich erstellt wurde, wird das neue API-Deployment mit dem Status "Aktiv" angezeigt.

    Anstatt das neue API-Deployment 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.

13. Wenn Sie bereits mehr als ein paar Minuten darauf warten, dass das API-Deployment mit dem Status "Aktiv" angezeigt wird (oder wenn die Erstellung des API-Deployments nicht erfolgreich war), gehen Sie wie folgt vor:

    1. Wählen Sie den Namen des API-Deployment aus, und wählen Sie Arbeitsanforderungen aus, um einen Überblick über den Vorgang zum Erstellen des API-Deployment anzuzeigen.
    2. Wählen Sie den Vorgang Deployment erstellen aus, um weitere Informationen zum Vorgang anzuzeigen (einschließlich Fehlermeldungen, Logmeldungen und Status der zugehörigen Ressourcen).
    3. Wenn der Vorgang zum Erstellen des API-Deployments nicht erfolgreich war und Sie die Ursache des Problems nicht anhand der Arbeitsanforderungsinformationen diagnostizieren können, gehen Sie zu API-Gateway-Fehler beheben.
14. (Optional) Bestätigen Sie, dass die API erfolgreich bereitgestellt wurde, indem Sie sie aufrufen (siehe In einem API-Gateway bereitgestellte API aufrufen).

So erstellen Sie mit der Konsole ein API-Deployment und laden die API-Deployment-Spezifikation aus einer JSON-Datei hoch:

1. Wählen Sie auf der Listenseite Gateways das API-Gateway aus, auf dem Sie die API bereitstellen möchten. Wenn Sie Hilfe beim Suchen der Listenseite oder des API-Gateways benötigen, finden Sie weitere Informationen unter API-Gateways auflisten.
2. Wählen Sie auf der Seite Gatewaydetails Bereitstellungen aus der Liste Ressourcen und dann Deployment erstellen aus.
3. Wählen Sie Vorhandene API hochladen aus.

4. Geben Sie im Abschnitt Informationen hochladen Folgendes an:

   • Name: Den Namen des neuen API-Deployments. Vermeiden Sie die Eingabe von vertraulichen Informationen.

   • Pfadpräfix: Einen Pfad, in dem alle Routen bereitgestellt werden sollen, die in der API-Deployment-Spezifikation enthalten sind. Beispiel:

     • /v1
     • /v2
     • /test/20191122

     Beachten Sie, dass das angegebene Deployment-Pfadpräfix:

     • einen Vorwärtsschrägstrich (/ ) vorangestellt haben muss. Es kann nur ein einzelner Vorwärtsschrägstrich verwendet werden
     • mehrere Schrägstriche enthalten kann (sofern diese nicht aufeinander folgen), jedoch nicht mit einem Schrägstrich enden darf
     • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
     • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
     • keine Parameter und Platzhalter enthalten darf
   • Compartment: Das Compartment, in dem das neue API-Deployment erstellt werden soll.
   • Spezifikation: Die JSON-Datei mit der API-Deployment-Spezifikation, entweder durch Ziehen und Ablegen der Datei oder durch Auswahl von auswählen. Siehe API-Deployment-Spezifikation erstellen.

   Wenn ein API-Deployment einen einzelnen Schrägstrich als Deployment-Pfadpräfix aufweist, ist dies das einzige API-Deployment, das für ein bestimmtes API-Gateway zulässig ist. Sie können kein API-Deployment mit einem einzelnen Schrägstrich als Deployment-Pfadpräfix erstellen, wenn bereits ein anderes API-Deployment auf demselben API-Gateway vorhanden ist.

5. (Optional) Wählen Sie Erweiterte Optionen anzeigen, und geben Sie optional Folgendes an:

   • Tags: Wenn Sie über Berechtigungen zum Erstellen von Ressourcen verfügen, können Sie auf die Ressource auch Freiformtags 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.
6. Wählen Sie Weiter aus, um die Details zu prüfen, die Sie für das neue API-Deployment eingegeben haben.

7. Wählen Sie Erstellen aus, um das neue API-Deployment zu erstellen.

   Es kann einige Minuten dauern, bis das neue API-Deployment erstellt wird. Während der Erstellung wird das API-Deployment auf der Seite Gatewaydetails mit dem Status "Wird erstellt" angezeigt. Sobald es erfolgreich erstellt wurde, wird das neue API-Deployment mit dem Status "Aktiv" angezeigt.

   Anstatt das neue API-Deployment 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.

8. Wenn Sie bereits mehr als ein paar Minuten darauf warten, dass das API-Deployment mit dem Status "Aktiv" angezeigt wird (oder wenn die Erstellung des API-Deployments nicht erfolgreich war), gehen Sie wie folgt vor:

   1. Wählen Sie den Namen des API-Deployment aus, und wählen Sie Arbeitsanforderungen aus, um einen Überblick über den Vorgang zum Erstellen des API-Deployment anzuzeigen.
   2. Wählen Sie den Vorgang Deployment erstellen aus, um weitere Informationen zum Vorgang anzuzeigen (einschließlich Fehlermeldungen, Logmeldungen und Status der zugehörigen Ressourcen).
   3. Wenn der Vorgang zum Erstellen des API-Deployments nicht erfolgreich war und Sie die Ursache des Problems nicht anhand der Arbeitsanforderungsinformationen diagnostizieren können, gehen Sie zu API-Gateway-Fehler beheben.
9. (Optional) Bestätigen Sie, dass die API erfolgreich bereitgestellt wurde, indem Sie sie aufrufen (siehe In einem API-Gateway bereitgestellte API aufrufen).

Sie können ein API-Deployment aus einer vorhandenen API-Ressource mithilfe der API-Beschreibung der API-Ressource erstellen. In diesem Fall basiert die API-Beschreibung auf einer API-Beschreibungsdatei, die Sie für die API-Ressource hochgeladen haben (siehe API-Ressource mit einer API-Beschreibung erstellen). Die API-Beschreibungsdatei enthält einige Anfangswerte für die API-Deployment-Spezifikation, die Sie beim Erstellen des API-Deployments ändern und erweitern können. Insbesondere wird für jeden Pfad und jede zugehörige Methode in der API-Beschreibung eine Standardroute erstellt.

So erstellen Sie mit der Konsole ein API-Deployment aus einer vorhandenen API-Ressource mithilfe einer API-Deployment-Spezifikation, die aus einer API-Beschreibungsdatei abgeleitet wurde:

1. Wählen Sie auf der Listenseite APIs den Namen der API-Ressource aus, die Sie bereitstellen möchten. Wenn Sie Hilfe beim Suchen der Listenseite benötigen, finden Sie weitere Informationen unter API-Ressourcen auflisten.
2. (Optional) Wählen Sie auf der Seite API-Details in der Liste Ressourcen die Option API-Deployment-Spezifikation aus, um zu bestätigen, dass eine gültige API-Deployment-Spezifikation für die API-Ressource aus einer hochgeladenen API-Beschreibungsdatei erstellt wurde. Wenn keine API-Deployment-Spezifikation verfügbar ist, finden Sie weitere Informationen unter API-Ressource mit einer API-Beschreibung erstellen.
3. Wählen Sie auf der Seite API-Details die Option API-Gateway bereitstellen aus, um die Konsolendialoge zum Erstellen eines API-Deployments zu verwenden.

   Einige der Anfangswerte für die Eigenschaften der API-Deployment-Spezifikation, die in den Dialogfeldern der Konsole angezeigt werden, werden aus der API-Beschreibungsdatei abgeleitet.

   Im Abschnitt API-Informationen werden Details zur API-Ressource angezeigt, aus der das API-Deployment erstellt wird.

4. Wählen Sie im Abschnitt Gateway das API-Gateway aus, in dem Sie das API-Deployment erstellen möchten. Wenn noch kein geeignetes API-Gateway vorhanden ist, wählen Sie Gateway erstellen aus, um ein Gateway zu erstellen (siehe API-Gateway erstellen.

5. Geben Sie im Abschnitt Basisinformationen Folgendes an:

   • Name: Den Namen des neuen API-Deployments. Vermeiden Sie die Eingabe von vertraulichen Informationen.

   • Pfadpräfix: Einen Pfad, in dem alle Routen bereitgestellt werden sollen, die in der API-Deployment-Spezifikation enthalten sind.

     Beispiel:

     • /v1
     • /v2
     • /test/20191122

     Beachten Sie, dass das angegebene Deployment-Pfadpräfix:

     • einen Vorwärtsschrägstrich (/ ) vorangestellt haben muss. Es kann nur ein einzelner Vorwärtsschrägstrich verwendet werden
     • mehrere Schrägstriche enthalten kann (sofern diese nicht aufeinander folgen), jedoch nicht mit einem Schrägstrich enden darf
     • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
     • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
     • keine Parameter und Platzhalter enthalten darf

     Wenn ein API-Deployment einen einzelnen Schrägstrich als Deployment-Pfadpräfix aufweist, ist dies das einzige API-Deployment, das für ein bestimmtes API-Gateway zulässig ist. Sie können kein API-Deployment mit einem einzelnen Schrägstrich als Deployment-Pfadpräfix erstellen, wenn bereits ein anderes API-Deployment auf demselben API-Gateway vorhanden ist.

   • Compartment: Das Compartment, in dem das neue API-Deployment erstellt werden soll.

6. (Optional) Geben Sie im Abschnitt API-Anforderungs-Policys optional Anforderungs-Policy-Details an, um Folgendes zu unterstützen:

   • Mutual-TLS: Wählen Sie mTLS aktivieren aus, und geben Sie Details zu einer mTLS-Anforderungs-Policy ein (siehe mTLS-Unterstützung zu API-Deployments hinzufügen).
   • Authentifizierung: Wählen Sie Hinzufügen aus, und geben Sie Details zu einer Authentifizierungsanforderungs-Policy ein (siehe Authentifizierung und Autorisierung zu API-Deployments hinzufügen).
   • CORS: Wählen Sie Hinzufügen aus, und geben Sie Details zu einer CORS-Anforderungs-Policy ein (siehe CORS-Support zu API-Deployments hinzufügen).
   • Ratenbeschränkung: Wählen Sie Hinzufügen aus, und geben Sie Details zu einer Anforderungs-Policy zur Ratenbeschränkung ein (siehe Anzahl von Anforderungen an API-Gateway-Backends begrenzen).

7. (Optional) Geben Sie im Abschnitt API-Logging-Policys optional eine Ausführungslogebene an, um Informationen über die Verarbeitung innerhalb des API-Gateways aufzuzeichnen. Siehe Logging zu API-Deployments hinzufügen.

8. (Optional) Wählen Sie Erweiterte Optionen anzeigen, und geben Sie optional Folgendes an:

   • Tags: Wenn Sie über Berechtigungen zum Erstellen von Ressourcen verfügen, können Sie auf die Ressource auch Freiformtags 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.

9. Wählen Sie Weiter aus, um Details der Routen im API-Deployment anzuzeigen und einzugeben.

   Standardmäßig wird für jeden Pfad und jede zugehörige Methode in der API-Beschreibung eine Route erstellt. Zunächst wird jede dieser Standardrouten mit einem Standardantwort-Backend erstellt. Der HTTP-Statuscode, der Inhalt im Body des Antwortbodyinhalts und der Header werden aus den Details in der API-Beschreibung abgerufen. Wenn die API-Beschreibung keine Antwortinformationen für einen bestimmten Pfad und die zugehörige Methode enthält, wird für diese Route ein Standardantwort-Backend mit 501 als HTTP-Statuscode erstellt.

10. Prüfen Sie die einzelnen Standardrouten nacheinander, ändern Sie gegebenenfalls die Konfiguration, um Ihre Anforderungen zu erfüllen, und fügen Sie Anforderungs-, Antwort- und Logging-Policys hinzu:

    • Pfad: Einen Pfad zum Backend-Service für API-Aufrufe, die die aufgeführten Methoden verwenden. Beachten Sie, dass der von Ihnen angegebene Routenpfad:

      • relativ zum Deployment-Pfadpräfix ist
      • einen Schrägstrich ( / ) vorangestellt haben muss. Es kann nur ein einzelner Schrägstrich verwendet werden
      • mehrere Schrägstriche enthalten (sofern diese nicht aufeinander folgen) und mit einem Schrägstrich enden kann
      • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
      • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
      • Parameter und Platzhalter enthalten kann (siehe Pfadparameter und Platzhalter zu Routenpfaden hinzufügen)
    • Methoden: Eine oder mehrere Methoden, die vom Backend-Service akzeptiert werden (durch Komma getrennt). Beispiel: GET, PUT.
    • Typ: Den Typ des Backend-Service. Wählen Sie dazu eine der folgenden Optionen:
      • HTTP: Bei einem HTTP-Backend müssen Sie auch eine URL und Timeoutdetails angeben. Außerdem müssen Sie angeben, ob die SSL-Überprüfung deaktiviert werden soll (siehe HTTP- oder HTTPS-URL als API-Gateway-Backend hinzufügen).
      • Oracle Functions: Wenn Sie ein OCI Functions-Backend verwenden, müssen Sie auch die Anwendung und Funktion angeben (siehe Funktion in OCI Functions als API-Gateway-Backend hinzufügen).
      • Standardantwort: Bei einem Standardantwort-Backend müssen Sie auch den HTTP-Statuscode, den Inhalt im Hauptteil der Antwort und mindestens ein HTTP-Headerfeld angeben (siehe Standardantworten als API-Gateway-Backend hinzufügen).
    • Routenanforderungs-Policys einblenden: und Routenantwort-Policys einblenden: Prüfen und aktualisieren Sie optional die Anforderungs-Policys und Antwort-Policys, die für die Route gelten. Siehe Anforderungs-Policys und Antwort-Policys zu API-Deployment-Spezifikationen hinzufügen.
    • Routenlogging-Policys einblenden: Prüfen und aktualisieren Sie optional die Logging-Policy, die für die Route gilt. Siehe Logging zu API-Deployments hinzufügen.
11. (Optional) Wählen Sie Weitere Route aus, um zusätzlich zu den standardmäßig aus der API-Beschreibung erstellten Routen Details zu weiteren Routen einzugeben.
12. Wählen Sie Weiter aus, um die Details zu prüfen, die Sie für das neue API-Deployment eingegeben haben.

13. Wählen Sie Erstellen aus, um das neue API-Deployment zu erstellen.

    Es kann einige Minuten dauern, bis das neue API-Deployment erstellt wird. Während der Erstellung wird das API-Deployment auf der Seite Gatewaydetails mit dem Status "Wird erstellt" angezeigt. Sobald es erfolgreich erstellt wurde, wird das neue API-Deployment mit dem Status "Aktiv" angezeigt.

14. Wenn Sie bereits mehr als ein paar Minuten darauf warten, dass das API-Deployment mit dem Status "Aktiv" angezeigt wird (oder wenn die Erstellung des API-Deployments nicht erfolgreich war), gehen Sie wie folgt vor:

    1. Wählen Sie den Namen des API-Deployment aus, und wählen Sie Arbeitsanforderungen aus, um einen Überblick über den Vorgang zum Erstellen des API-Deployment anzuzeigen.
    2. Wählen Sie den Vorgang Deployment erstellen aus, um weitere Informationen zum Vorgang anzuzeigen (einschließlich Fehlermeldungen, Logmeldungen und Status der zugehörigen Ressourcen).
    3. Wenn der Vorgang zum Erstellen des API-Deployments nicht erfolgreich war und Sie die Ursache des Problems nicht anhand der Arbeitsanforderungsinformationen diagnostizieren können, gehen Sie zu API-Gateway-Fehler beheben.
15. (Optional) Bestätigen Sie, dass die API erfolgreich bereitgestellt wurde, indem Sie sie aufrufen (siehe In einem API-Gateway bereitgestellte API aufrufen).

So erstellen Sie ein neues API-Deployment mit der CLI:

1. Konfigurieren Sie die Clientumgebung zur Verwendung der CLI (Clientumgebung zur Verwendung der CLI für API-Gateway-Entwicklung konfigurieren).

2. Öffnen Sie eine Eingabeaufforderung, und führen Sie oci api-gateway deployment create aus, um das Deployment zu erstellen:

   oci api-gateway deployment create --compartment-id <compartment-ocid> --display-name <api-name> --gateway-id <gateway-ocid> --path-prefix "/<deployment-path-prefix>" --specification file:///<filename>
   

   Dabei gilt:

   • <compartment-ocid> ist die OCID des Compartments, in dem das neue API-Deployment erstellt werden soll.
   • <api-name> ist der Name des neuen API-Deployments. Vermeiden Sie die Eingabe von vertraulichen Informationen.
   • <gateway-ocid> ist die OCID des vorhandenen Gateways, in dem die API bereitgestellt werden soll. Unter API-Gateways auflisten können Sie die OCID des API-Gateway ermitteln.

   • /<deployment-path-prefix> ist ein Pfad, in dem alle Routen bereitgestellt werden sollen, die in der API-Deployment-Spezifikation enthalten sind.

     Beachten Sie, dass das angegebene Deployment-Pfadpräfix:

     • in der JSON-Datei einen Schrägstrich ( / ) vorangestellt haben muss und nur diesen einzelnen Schrägstrich enthalten kann
     • mehrere Schrägstriche enthalten kann (sofern diese nicht aufeinander folgen), jedoch nicht mit einem Schrägstrich enden darf
     • alphanumerische Zeichen in Großbuchstaben und Kleinbuchstaben enthalten kann
     • die folgenden Sonderzeichen enthalten kann: $ - _ . + ! * ' ( ) , % ; : @ & =
     • keine Parameter und Platzhalter enthalten darf

     Wenn ein API-Deployment einen einzelnen Schrägstrich als Deployment-Pfadpräfix aufweist, ist dies das einzige API-Deployment, das für ein bestimmtes API-Gateway zulässig ist. Sie können kein API-Deployment mit einem einzelnen Schrägstrich als Deployment-Pfadpräfix erstellen, wenn bereits ein anderes API-Deployment auf demselben API-Gateway vorhanden ist.

   • <filename> ist die API-Deployment-Spezifikation, einschließlich Pfad, Methode (eine oder mehrere) und Backend-Definition. Siehe API-Deployment-Spezifikation erstellen.

   Beispiel:

   oci api-gateway deployment create --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --display-name "Marketing Deployment" --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --path-prefix "/marketing" --specification file:///Users/jdoe/work/deployment.json

   Die Antwort auf den Befehl umfasst Folgendes:

   • Die OCID des API-Deployments.

   • Den Namen des Hosts, auf dem das API-Deployment erstellt wurde, als Domainname im Format <gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com. Dabei gilt:

     • <gateway-identifier> ist die Zeichenfolge, die das API-Gateway identifiziert. Beispiel: lak...sjd (abgekürzt für Lesbarkeit).
     • <region-identifier> ist die ID der Region, in der das API-Deployment erstellt wurde. Siehe Verfügbarkeit nach Region.

     Beispiel: lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com.

     Der Hostname ist der Domainname, der beim Aufrufen einer im API-Gateway bereitgestellten API verwendet werden soll.

   • Den Lebenszyklusstatus (Beispiel: ACTIVE, FAILED).
   • Die ID der Arbeitsanforderung zum Erstellen des API-Deployments (Details der Arbeitsanforderungen sind für sieben Tage nach Abschluss, Abbruch oder Fehler verfügbar).

   Wenn der Befehl die Steuerung erst dann zurückgeben soll, wenn das API-Deployment aktiv ist (oder die Anforderung nicht erfolgreich war), nehmen Sie einen oder beide der folgenden Parameter auf:

   • --wait-for-state ACTIVE
   • --wait-for-state FAILED

   Beispiel:

   oci api-gateway deployment create --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --display-name "Marketing Deployment" --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --path-prefix "/marketing" --specification file:///Users/jdoe/work/deployment.json --wait-for-state ACTIVE

   Beachten Sie, dass Sie das API-Deployment erst verwenden können, wenn es durch die Arbeitsanforderung erfolgreich erstellt wurde und das API-Deployment aktiv ist.

3. (Optional) Um den Status des API-Deployments anzuzeigen, geben Sie Folgendes ein:

   oci api-gateway deployment get --deployment-id <deployment-ocid>

4. (Optional) Um den Status der Arbeitsanforderung anzuzeigen, die das API-Deployment erstellt, geben Sie Folgendes ein:

   oci api-gateway work-request get --work-request-id <work-request-ocid>

5. (Optional) Um die Logs der Arbeitsanforderung anzuzeigen, die das API-Deployment erstellt, geben Sie Folgendes ein:

   oci api-gateway work-request-log list --work-request-id <work-request-ocid>

6. (Optional) Wenn die Arbeitsanforderung, die das API-Deployment erstellt, nicht erfolgreich ist und Sie die Fehlerlogs prüfen möchten, geben Sie Folgendes ein:

   oci api-gateway work-request-error --work-request-id <work-request-ocid>

Weitere Informationen zur Verwendung der CLI finden Sie unter Befehlszeilenschnittstelle (CLI). Eine vollständige Liste der Flags und Optionen, die für CLI-Befehle verfügbar sind, finden Sie in der CLI-Hilfe.

Informationen zur Verwendung der API und zu Signieranforderungen finden Sie unter REST-API-Dokumentation und Sicherheitszugangsdaten. Informationen zu SDKs finden Sie unter SDKs und die CLI.

Mit dem CreateDeployment-Vorgang können Sie ein API-Deployment erstellen.