Deaktivieren des Standardendpunkts für REST-APIs - Amazon API Gateway

Deaktivieren des Standardendpunkts 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. Wenn Sie den Standardendpunkt deaktivieren, wirkt sich dies auf alle Stufen einer API aus.

Der folgende Vorgang zeigt, wie ein Standardendpunkt für eine HTTP-API deaktiviert wird.

AWS Management Console

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

  2. Wählen Sie eine HTTP-API.

  3. Wählen Sie die ID Ihrer API aus, um die Seite mit den API-Details zu öffnen.

  4. Klicken Sie unter API-Details auf Bearbeiten.

  5. Klicken Sie unter Standardendpunkt auf Deaktivieren.

  6. Wählen Sie Speichern aus.

    Wenn Sie für Ihre Stufe automatische Bereitstellungen aktivieren, müssen Sie Ihre API nicht erneut bereitstellen, damit die Änderung wirksam wird. Andernfalls müssen Sie Ihre API erneut bereitstellen.

  7. (Optional) Klicken Sie auf Bereitstellen und stellen Sie Ihre API erneut bereit oder erstellen Sie eine neue Stufe, in der die Änderung wirksam werden soll.

AWS CLI

Der update-domain-name-Befehl deaktiviert den Standardendpunkt einer HTTP-API:

aws apigatewayv2 update-api \
    --api-id abcdef123 \
    --disable-execute-api-endpoint

Nachdem Sie den Standardendpunkt deaktiviert haben, müssen Sie Ihre API bereitstellen, damit die Änderung wirksam wird, es sei denn, automatische Bereitstellungen sind aktiviert.

Der Befehl create-deployment erstellt eine Bereitstellung:

aws apigatewayv2 create-deployment \
    --api-id abcdef123 \
    --stage-name dev