將 API 階段映射至 WebSocket API 的自訂網域名稱

您可以使用 API 映射將 API 階段連線至自訂網域名稱。建立網域名稱並設定 DNS 記錄之後，您可以使用 API 映射，透過自訂網域名稱將流量傳送至您的 API。

API 映射指定一個 API，一個階段，以及選擇性用於映射的路徑。例如，您可以將 API 的 production 階段映射至 wss://api.example.com/orders。

建立 API 映射之前，您必須先擁有 API、階段和自訂網域名稱。如需進一步了解如何建立自訂網域名稱，請參閱在 API Gateway 中設定區域性自訂網域名稱。

限制

• 在 API 映射中，自訂網域名稱和映射APIs 必須在相同的 AWS 帳戶中。

• API 映射只能包含字母、數字和下列字元：$-_.+!*'()。

• API 映射中路徑的最大長度為 300 個字元。

• 您無法將 WebSocket API 映射至與 HTTP API 或 REST API 相同的自訂網域名稱。

• 如果您建立具有多層的 API 映射，API Gateway 會將所有標頭名稱轉換為小寫。

建立 API 映射

若要建立 API 映射，您必須先建立自訂網域名稱、API 和階段。如需建立自訂網域名稱的資訊，請參閱在 API Gateway 中設定區域性自訂網域名稱。

AWS Management Console

建立 API 映射

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

2. 選擇 Custom domain names (自訂網域名稱)。

3. 選取您已建立的自訂網域名稱。

4. 選擇 API mappings (API 映射)。

5. 選擇 Configure API mappings (設定 API 映射)。

6. 選擇 Add new mapping (新增映射)。

7. 輸入 API、Stage (階段)，以及選擇性地輸入 Path (路徑)。

8. 選擇 Save (儲存)。

AWS CLI

下列 create-api-mapping 命令會建立 API 映射。在此範例中，API Gateway 會將請求傳送至 api.example.com/v1，到指定的 API 和階段。

aws apigatewayv2 create-api-mapping \
    --domain-name api.example.com \
    --api-mapping-key v1 \
    --api-id a1b2c3d4 \
    --stage test

AWS CloudFormation

下列 AWS CloudFormation 範例會建立 API 映射。

MyApiMapping:
  Type: 'AWS::ApiGatewayV2::ApiMapping'
  Properties:
    DomainName: api.example.com
    ApiMappingKey: 'v1'
    ApiId: !Ref MyApi
    Stage: !Ref MyStage