Öffentlichen oder privaten API-Endpunkttyp in API Gateway ändern - Amazon API Gateway
API-Endpunkttyp über die API Gateway-Konsole ändernVerwenden der AWS CLI zum Ändern eines API-Endpunkttyps

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Öffentlichen oder privaten API-Endpunkttyp in API Gateway ändern

Das Ändern eines API-Endpunkttyps erfordert, dass Sie die Konfiguration der API aktualisieren. Sie können einen vorhandenen API-Typ über die API-Gateway-Konsole, die AWS CLI oder ein AWS SDK für API Gateway ändern. Der Endpunkttyp kann erst wieder geändert werden, wenn die aktuelle Änderung abgeschlossen ist, aber Ihre API ist verfügbar.

Die folgenden Änderungen am Endpunkttyp werden nicht unterstützt:

  • Von Edge-optimiert in regional oder privat

  • Von regional in Edge-optimiert oder privat

  • Von privat in regional

Sie können eine private API nicht in eine Edge-optimierte API ändern.

Wenn Sie eine öffentliche API von Edge-optimiert in regional (oder umgekehrt) umwandeln, sollten Sie beachten, dass eine Edge-optimierte API sich anders als eine regionale API verhalten kann. Bei einer Edge-optimierten API wird beispielsweise der Content-MD5-Header entfernt. Ein an das Backend übergebener MD5-Hash-Wert kann in einem Anforderungszeichenfolgenparameter oder einer Texteigenschaft dargestellt werden. Die regionale API übergibt diesen Header jedoch, obwohl dadurch der Header-Name einem anderen Namen zugeordnet werden kann. Sie müssen die Unterschiede verstehen, um zu entscheiden, wie Sie eine Edge-optimierte API zu einer regionalen oder umgekehrt machen.

API-Endpunkttyp über die API Gateway-Konsole ändern

Um den API-Endpunkttyp Ihrer API zu ändern, führen Sie einen der folgenden Schritte aus:

So wandeln Sie einen öffentlichen Endpunkt von regional zu Edge-optimiert oder umgekehrt um

  1. Melden Sie sich bei der API Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

  2. Wählen Sie eine REST-API aus.

  3. Wählen Sie API-Einstellungen aus.

  4. Wählen Sie im Abschnitt API-Details die Option Bearbeiten aus.

  5. Wählen Sie als API-Endpunkttyp entweder Edge-optimiert oder Regional aus.

  6. Klicken Sie auf Änderungen speichern.

  7. Stellen Sie die API erneut bereit, sodass die Änderungen wirksam werden.

So konvertieren Sie einen privaten Endpunkt in einen regionalen Endpunkt

  1. Melden Sie sich bei der API Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

  2. Wählen Sie eine REST-API aus.

  3. Bearbeiten Sie die Ressourcenrichtlinie für Ihre API und entfernen Sie alle Hinweise auf VPCs oder VPC-Endpunkte, sodass API-Aufrufe von außerhalb Ihrer VPC als auch innerhalb Ihrer VPC erfolgreich ausgeführt werden können.

  4. Wählen Sie API-Einstellungen aus.

  5. Wählen Sie im Abschnitt API-Details die Option Bearbeiten aus.

  6. Wählen Sie für API-Endpunkttyp die Option Regional aus.

  7. Klicken Sie auf Änderungen speichern.

  8. Entfernen Sie die Ressourcenrichtlinie aus Ihrer API.

  9. Stellen Sie die API erneut bereit, sodass die Änderungen wirksam werden.

    Da Sie den Endpunkttyp von „Privat“ zu „Regional“ migrieren, ändert API Gateway den IP-Adresstyp in „IPv4“. Weitere Informationen finden Sie unter IP-Adresstypen für REST-APIs in API Gateway.

So konvertieren Sie einen privaten Endpunkt in einen regionalen Endpunkt

  1. Melden Sie sich bei der API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

  2. Wählen Sie eine REST-API aus.

  3. Erstellen Sie eine Ressourcenrichtlinie, die Zugriff auf Ihre VPC oder Ihren VPC-Endpunkt gewährt. Weitere Informationen finden Sie unter Schritt 3: Einrichten einer Ressourcenrichtlinie für eine private API.

  4. Wählen Sie API-Einstellungen aus.

  5. Wählen Sie im Abschnitt API-Details die Option Bearbeiten aus.

  6. Wählen Sie für API endpoint type (API-Endpunkttyp) die Option Private (Privat) aus.

  7. (Optional) Wählen Sie für VPC-Endpunkt-IDs die VPC-Endpunkt-IDs aus, die Sie Ihrer privaten API zuordnen möchten.

  8. Klicken Sie auf Änderungen speichern.

  9. Stellen Sie die API erneut bereit, sodass die Änderungen wirksam werden.

    Da Sie den Endpunkttyp von „Regional“ zu „Privat“ migrieren, ändert API Gateway den IP-Adresstyp in „Dualstack“. Weitere Informationen finden Sie unter IP-Adresstypen für REST-APIs in API Gateway.

Verwenden der AWS CLI zum Ändern eines API-Endpunkttyps

Der folgende update-rest-api-Befehl aktualisiert eine Edge-optimierte API auf eine regionale API: 

aws apigateway update-rest-api \
    --rest-api-id a1b2c3 \
    --patch-operations op=replace,path=/endpointConfiguration/types/EDGE,value=REGIONAL

Die erfolgreiche Antwort verfügt über einen Statuscode von 200 OK und eine Nutzlast, die etwa wie folgt aussieht:

{
    "createdDate": "2017-10-16T04:09:31Z",
    "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints",
    "endpointConfiguration": {
        "types": "REGIONAL"
    },
    "id": "a1b2c3",
    "name": "PetStore imported as edge-optimized"
}

Der folgende update-rest-api-Befehl aktualisiert eine regionale API auf eine Edge-optimierte API:

aws apigateway update-rest-api \
    --rest-api-id a1b2c3 \
    --patch-operations op=replace,path=/endpointConfiguration/types/REGIONAL,value=EDGE

Da put-rest-api dem Aktualisieren von API-Definitionen dient, können API-Endpunkttypen damit nicht aktualisiert werden.