Deaktivieren Sie den Standardendpunkt für REST APIs

Standardmäßig können Clients Ihre API mithilfe des execute-api-Endpunkts aufrufen, den API Gateway für Ihre API generiert. Um sicherzustellen, dass Kunden nur über einen benutzerdefinierten Domänennamen auf Ihre API zugreifen können, deaktivieren Sie den standardmäßigen execute-api-Endpunkt. Clients können weiterhin eine Verbindung mit Ihrem Standardendpunkt herstellen, erhalten jedoch einen 403 Forbidden-Statuscode. Die Deaktivierung des Standardendpunkts wirkt sich auf alle Phasen der API aus. Diese Einstellung wird wirksam, wenn Sie eine Einstellung in einer beliebigen Phase aktualisieren, z. B. wenn Sie die Bereitstellung in der Phase aktualisieren.

Im folgenden Vorgang sehen Sie, wie Sie den Standardendpunkt einer REST-API deaktivieren.

AWS Management Console

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

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

3. Klicken Sie im Hauptnavigationsbereich auf API-Einstellungen.

4. Wählen Sie eine API aus.

5. Klicken Sie unter API-Details auf Bearbeiten.

6. Wählen Sie unter Standardendpunkt die Option Inaktiv aus.

7. Wählen Sie Änderungen speichern aus.

8. Klicken Sie im Hauptnavigationsbereich auf Ressourcen.

9. Klicken Sie auf Deploy API.

10. Stellen Sie Ihre API erneut in einer Phase bereit oder aktualisieren Sie alle Einstellungen in einer Phase, damit das Update wirksam wird.

AWS CLI

Der folgende update-rest-apiBefehl deaktiviert den Standardendpunkt:

aws apigateway update-rest-api \
    --rest-api-id abcdef123 \
    --patch-operations op=replace,path=/disableExecuteApiEndpoint,value='True'

Nachdem Sie den Standardendpunkt deaktiviert haben, müssen Sie Ihre API bereitstellen, damit die Änderung wirksam wird.

Der folgende Befehl create-deployment erstellt eine Bereitstellung und ordnet sie einer Phase zu:

aws apigateway create-deployment \
    --rest-api-id abcdef123 \
    --stage-name dev