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

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

停用 REST API 的預設端點

預設情況下，用戶端可以使用 API Gateway 為 API 產生的 execute-api 端點來叫用 API。若要確保用戶端只能使用自訂網域名稱來存取您的 API，請停用預設 execute-api 端點。用戶端仍然可以連線到您的預設端點，但會收到 403 Forbidden 狀態碼。當您停用預設端點時，它會影響 API 的所有階段。

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

AWS Management Console

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

  2. 選擇 REST API。

  3. 在主導航窗格上，選擇 API 設置。

  4. 選擇一個 API。

  5. 在 API 詳細資料上，選擇編輯。

  6. 針對預設端點，選取非作用中。

  7. 選擇儲存變更。

  8. 在主導覽窗格中，選擇 [資源]。

  9. 選擇部署 API。

  10. 重新部署您的 API 或建立新階段，讓變更生效。

AWS CLI

下列update-rest-api命令顯示如何停用預設端點：

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

停用預設端點之後，您必須部署 API，變更才會生效。

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

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