Oracle Cloud Infrastructure - Dokumentation

API-Gateway aktualisieren

Erfahren Sie, wie Sie API-Gateways ändern, die Sie zuvor mit dem API Gateway-Service erstellt haben.

Nachdem Sie ein API-Gateway erstellt haben, können Sie das API-Gateway ändern. Beispiel: Sie möchten den Namen des API-Gateways oder die darauf angewendeten Tags ändern.

Beachten Sie, dass Sie bei einigen Eigenschaften von API-Gateways die Originalwerte nicht ändern können.

Sie können API-Gateways mit der Konsole, der CLI und der API aktualisieren.

    1. Suchen Sie auf der Listenseite Gateways das API-Gateway, das Sie aktualisieren möchten. Wenn Sie Hilfe beim Suchen der Listenseite oder des API-Gateways benötigen, finden Sie weitere Informationen unter API-Gateways auflisten.
    2. Im Menü Aktionen (drei Punkte) für das API-Gateway:
      • Wählen Sie Bearbeiten aus, um eine der folgenden API-Gateway-Eigenschaften zu ändern:
        • Ändern Sie den Namen des API-Gateways. Vermeiden Sie die Eingabe von vertraulichen Informationen.
        • Aktivieren oder deaktivieren Sie die Verwendung von Netzwerksicherheitsgruppen (NSGs) zur Kontrolle des Zugriffs auf und vom API-Gateway mit Sicherheitsregeln, die für die von Ihnen angegebenen NSGs definiert sind (maximal fünf Netzwerksicherheitsgruppen). Sie können für NSGs definierte Sicherheitsregeln anstelle von oder zusätzlich zu den für Sicherheitslisten definierten Sicherheitsregeln verwenden. NSGs können zu demselben Compartment wie das API-Gateway gehören, müssen dies jedoch nicht. Siehe Netzwerksicherheitsgruppen.
        • Ändern Sie das TLS-Zertifikat und den Domainnamen, die vom API-Gateway verwendet werden. Beachten Sie, dass API Gateway-Zertifikatsressourcen und Certificates-Servicezertifikatsressourcen nur angezeigt werden, wenn sie im ausgewählten Compartment verfügbar sind. Siehe Benutzerdefinierte Domains und TLS-Zertifikate einrichten.
        • Ändern Sie die Konfigurationseinstellungen für den Antwortcache. Siehe Antworten zur Verbesserung der Performance cachen.
        • Ändern Sie die Certificate Authoritys (CAs) und CA-Bundles, die im Truststore des API-Gateways enthalten sind, als benutzerdefinierte CAs und benutzerdefinierte CA-Bundles (zusätzlich zum Standard-CA-Bundle). Siehe Customizing Trust Stores for TLS Certificate Verification.
      • Wählen Sie Ressource verschieben aus, um das API-Gateway in ein anderes Compartment zu verschieben.
      • Wählen Sie die Registerkarte Tags aus, um die auf das API-Gateway angewendeten Tags anzuzeigen und zu bearbeiten, und wählen Sie Tags hinzufügen aus, um weitere Tags auf das API-Gateway anzuwenden.

  • So aktualisieren Sie vorhandene API-Gateways mit der CLI:

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

    2. So aktualisieren Sie ein vorhandenes API-Gateway:

      1. Öffnen Sie eine Eingabeaufforderung, und führen Sie oci api-gateway gateway update aus, um das API-Gateway zu aktualisieren:

        oci api-gateway gateway update --gateway-id <gateway-ocid> --<property-to-update> <property-value>

        Dabei gilt:

        • <gateway-ocid> ist die OCID des zu aktualisierenden API-Gateways. Unter API-Gateways auflisten können Sie die OCID des API-Gateway ermitteln.
        • <property-to-update> ist die zu aktualisierende Eigenschaft. Beachten Sie, dass Sie nur die Werte für display-name, --response-cache-details, --network-security-group-ids, --ca-bundles, freeform-tags und defined-tags ändern können (und certificate-id>, wenn dieser Wert ursprünglich für das API-Gateway festgelegt wurde). Alle anderen Werte müssen mit den Werten in der ursprünglichen Gatewaydefinition identisch sein.
        • <property-value> ist der neue Wert der zu ändernden Eigenschaft.

        Beispiel:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2"

        Die Antwort auf den Befehl umfasst Folgendes:

        • Den Lebenszyklusstatus (Beispiel: ACTIVE, FAILED).
        • Die ID der Arbeitsanforderung zum Aktualisieren des API-Gateways (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-Gateway 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 gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2" --wait-for-state ACTIVE

      2. (Optional) Um den Status der Arbeitsanforderung anzuzeigen, die das API-Gateway aktualisiert, geben Sie Folgendes ein:

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

      3. (Optional) Um die Logs der Arbeitsanforderung anzuzeigen, die das API-Gateway aktualisiert, geben Sie Folgendes ein:

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

      4. (Optional) Wenn die Arbeitsanforderung, die das API-Gateway aktualisiert, 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>

      5. (Optional) Um zu prüfen, ob das API-Gateway aktualisiert wurde, geben Sie den folgenden Befehl ein und bestätigen Sie, dass die Eigenschaften des API-Gateways wie erwartet sind:

        oci api-gateway gateway get --gateway-id <gateway-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.

  • Führen Sie den UpdateGateway-Vorgang aus, um ein API-Gateway zu aktualisieren.