停用 HTTP API 的預設端點 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

停用 HTTP API 的預設端點

預設情況下,用戶端可以使用 API Gateway 為 API 產生的 execute-api 端點來叫用 API。若要確保用戶端只能使用自訂網域名稱來存取您的 API,請停用預設 execute-api 端點。當您停用預設端點時,它會影響 API 的所有階段。

下列程序顯示如何停用 HTTP API 的預設端點。

AWS Management Console
  1. 在以下網址登入 API Gateway 主控台:https://console.aws.amazon.com/apigateway

  2. 選擇一個 HTTP API。

  3. 選擇您的 API ID 以開啟 API 詳細資訊頁面。

  4. API 詳細資料上,選擇編輯

  5. 針對預設端點,選取停用

  6. 選擇儲存

    如果您為舞台開啟自動部署,則無需重新部署 API 即可使變更生效。否則,您必須重新部署 API。

  7. (選擇性) 選擇「部署」,然後重新部署 API 或建立新階段,讓變更生效。

AWS CLI

下列update-domain-name命令會停用 HTTP API 的預設端點。

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

停用預設端點後,您必須部署 API 才能讓變更生效,除非已啟用自動部署。

下列建立部署指令會建立部署

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