Ö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 mit der API Gateway-Konsole AWS CLI, dem oder einem 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-Optimized zu Regional oder Private

• Von regional bis Edge-optimiert oder privat

• Von privat zu regional

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

Wenn Sie eine öffentliche API von Edge-Optimized auf Regional oder umgekehrt ändern, beachten Sie, dass sich eine Edge-optimierte API möglicherweise anders verhält als eine regionale API. 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 leitet diesen Header jedoch weiter, obwohl sie den Header-Namen möglicherweise einem anderen Namen zuordnet. Wenn Sie die Unterschiede kennen, können Sie leichter entscheiden, wie Sie eine Edge-optimierte API auf eine regionale oder von einer regionalen API auf eine Edge-optimierte API aktualisieren möchten.

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. Wählen Sie Änderungen speichern aus.

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. Wählen Sie Änderungen speichern aus.

8. Entfernen Sie die Ressourcenrichtlinie aus Ihrer API.

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

Um einen regionalen Endpunkt in einen privaten Endpunkt zu konvertieren

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: Richten Sie eine Ressourcenrichtlinie für ein privates Gerät ein 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. Wählen Sie Änderungen speichern aus.

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

Verwenden Sie die AWS CLI , um den Typ eines API-Endpunkts zu ändern

Rufen Sie wie folgt auf AWS CLI , um eine Edge-optimierte API mit der API-ID zu aktualisieren: {api-id} update-rest-api

aws apigateway update-rest-api \
    --rest-api-id {api-id} \
    --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": "0gsnjtjck8",
    "name": "PetStore imported as edge-optimized"
}

Wandeln Sie umgekehrt eine regionale API wie folgt in eine Edge-optimierte API um:

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

Da es put-rest-apisich um die Aktualisierung von API-Definitionen handelt, ist sie nicht für die Aktualisierung eines API-Endpunkttyps geeignet.