API Gateway 中 WebSocket API 的 IP 位址類型 - Amazon API Gateway

API Gateway 中 WebSocket API 的 IP 位址類型

建立 API 時,您可以指定可調用 API 的 IP 位址類型。您可以選擇 IPv4 來解析 IPv4 位址以調用 API,也可以選擇雙堆疊,以同時允許 IPv4 和 IPv6 位址調用您的 API。我們建議您將 IP 位址類型設定為雙堆疊,以緩解 IP 空間耗盡或用於安全狀態。如需雙堆疊 IP 位址類型優點的詳細資訊,請參閱 AWS 上的 IPv6

IP 位址類型的考量事項

下列考量事項可能會影響您使用 IP 位址類型:

  • 所有 WebSocket API 的預設 IP 位址類型都是 IPv4。

  • 如果您將現有 API 的 IP 位址類型從 IPv4 變更為雙堆疊,請確認控制存取 API 的任何政策都已更新,以便進行 IPv6 呼叫。當您變更 IP 位址類型時,變更會立即生效。

  • 您的 API 可以對應至與您的 API 具有不同 IP 位址類型的自訂網域名稱。如果您停用預設 API 端點,則可能會影響呼叫方調用 API 的方式。

變更 WebSocket API 的 IP 位址類型

您可以藉由更新 API 的組態來變更 IP 位址類型。您可以使用 AWS Management Console、AWS CLI、AWS CloudFormation 或 AWS SDK 來更新 API 的組態。如果您變更 API 的 IP 位址類型,您不需重新部署 API 讓變更生效。

AWS Management Console
若要變更 WebSocket API 的 IP 位址類型
  1. 在以下網址登入 API Gateway 主控台:https://console.aws.amazon.com/apigateway

  2. 選擇 WebSocket API。

  3. 選擇 API 設定,然後選擇編輯

  4. 針對 IP 位址類型,選取 IPv4雙堆疊

  5. 選擇儲存

    對 API 組態的變更會立即生效。

AWS CLI

以下 update-api 命令會將 API 更新為雙堆疊 IP 位址類型:

aws apigatewayv2 update-api \ --api-id abcd1234 \ --ip-address-type dualstack

輸出將如下所示:

{ "ApiEndpoint": "https://abcd1234.execute-api.us-east-1.amazonaws.com", "ApiId": "abcd1234", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2025-02-04T22:20:20+00:00", "DisableExecuteApiEndpoint": false, "Name": "My-WebSocket-API", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "NotificationUris": [], "IpAddressType": "dualstack" }