在 API Gateway 中设置区域自定义域名 - Amazon API Gateway

在 API Gateway 中设置区域自定义域名

使用区域自定义域名创建用户友好的 API 基本 URL。利用区域自定义域名,您可以将 HTTP 和 REST API 阶段映射到相同的自定义域名并使用双向 TLS 身份验证。

注意事项

以下是区域自定义域名的注意事项。

  • 您必须提供特定于区域的 ACM 证书。该证书必须与您的 API 位于同一区域。有关创建或上传自定义域名证书的更多信息,请参阅在 AWS Certificate Manager 中准备好证书

  • 在您创建(或迁移)包含 ACM 证书的区域自定义域名时,API Gateway 会在您的账户中创建一个服务相关角色。需要使用服务相关角色,才能将 ACM 证书附加到您的区域端点。该角色名为 AWSServiceRoleForAPIGateway,将对其附加 APIGatewayServiceRolePolicy 托管策略。有关使用服务相关角色的更多信息,请参阅使用服务相关角色

  • 创建区域自定义域名后,您必须创建将该自定义域名指向区域域名的“A”型 DNS 记录。这使绑定到自定义域名的流量可以路由到 API 的区域主机名。

创建区域自定义域名

以下过程说明了如何创建区域自定义域名。完成该过程后,您必须创建将自定义域名指向区域域名的 DNS 记录。

AWS Management Console
  1. 通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway

  2. 从主导航窗格中选择自定义域名

  3. 选择添加域列表

  4. 对于域名,输入一个域名。

  5. 对于 API 端点类型,请选择区域(推荐)

  6. 选择最低 TLS 版本。

  7. 选择双向 TLS 设置。

  8. 选择 ACM 证书。证书必须与 API 位于同一区域。

  9. 选择添加域列表

AWS CLI

以下 create-domain-name 命令可用于创建自定义域名:

aws apigatewayv2 create-domain-name \ --domain-name 'regional.example.com' \ --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

如果成功,调用返回的结果类似于以下内容:

{ "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "regional.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "DomainNameStatus": "AVAILABLE", "EndpointType": "REGIONAL", "HostedZoneId": "Z2OJLYMUO9EFXC", "SecurityPolicy": "TLS_1_2" } ] }

DomainNameConfigurations 属性值返回区域 API 的主机名。您必须创建将您的自定义域名指向此区域域名的 DNS 记录。这使指向自定义域名的流量可以路由到该区域 API 的主机名。

为区域自定义域名创建 DNS 记录

以下过程说明了如何创建将自定义域名指向新创建的区域域名的 DNS 记录。

AWS Management Console

要使用 AWS Management Console,请遵循有关配置 Route 53 以将流量路由到 API Gateway 的 Route 53 文档。

AWS CLI

要配置 DNS 记录来将区域自定义域名映射到给定托管区 ID 的主机名,首先要创建一个 JSON 文件,其中包含用于为区域域名设置 DNS 记录的配置。

以下 setup-dns-record.json 显示了如何创建 DNS A 记录,以将区域自定义域名 (regional.example.com) 映射到在创建自定义域名时为其预配置的区域主机名 (d-numh1z56v6.execute-api.us-west-2.amazonaws.com)。DNSNameHostedZoneIdAliasTarget 属性可分别采用自定义域名的 regionalDomainNameregionalHostedZoneId 值。您也可以在 Amazon API Gateway 端点和配额中获取区域 Route 53 托管区域 ID。

{ "Changes": [ { "Action": "CREATE", "ResourceRecordSet": { "Name": "regional.example.com", "Type": "A", "AliasTarget": { "DNSName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com", "HostedZoneId": "Z2OJLYMUO9EFXC", "EvaluateTargetHealth": false } } } ] }

下面的 change-resource-record-sets 展示了如何为区域自定义域名创建 DNS 记录:

aws route53 change-resource-record-sets \ --hosted-zone-id Z2OJLYMUO9EFXC \ --change-batch file://path/to/your/setup-dns-record.json

hosted-zone-id 替换为您账户中设置的 DNS 记录的 Route 53 托管区 ID。change-batch 参数值指向文件夹 (path/to/your) 中的 JSON 文件 (setup-dns-record.json)。

为区域自定义域名创建基本路径映射

创建 DNS 记录后,您可以创建基本路径映射以将您的 API 映射到自定义域名。例如,您可以使用 myApi 的 API 映射密钥,将 API ID 为 abc123 的阶段 test 映射到自定义域名 regional.example.com。这会将 API https://abcd1234.execute-api.us-west-2.amazonaws.com/test 映射到 https://regional.example.com/myApi

AWS Management Console
  1. 通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway

  2. 从主导航窗格中选择自定义域名

  3. 选择区域自定义域名

  4. API 映射选项卡上,选择配置 API 映射

  5. 输入映射的 API阶段路径

  6. 选择保存

AWS CLI

以下 create-api-mapping 命令可用于创建基本路径映射:

aws apigatewayv2 create-api-mapping \ --domain-name 'regional.example.com' \ --api-mapping-key 'myApi' \ --api-id abcd1234 \ --stage 'test'

这样,在此阶段部署的使用 API 的自定义域名的基本 URL 会变为 https://regional.example.com/myAPI

利用区域自定义域名,您可以创建具有多个级别的 API 映射,例如 https://regional.example.com/orders/v1/items/123。您还可以将 HTTP 和 REST API 阶段映射到相同的自定义域名。有关更多信息,请参阅 将 API 阶段映射到 REST API 的自定义域名