API Gateway HTTPAPIs中 的自訂網域名稱 - Amazon API Gateway
考量事項必要條件萬用字元自訂網域名稱自訂網域名稱的後續步驟

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

API Gateway HTTPAPIs中 的自訂網域名稱

自訂網域名稱更簡單、更直觀URLs，您可以提供給API使用者。

部署 之後API，您 （和您的客戶） 可以使用URL下列格式API的預設基礎叫用 ：

https://api-id.execute-api.region.amazonaws.com/stage

where api-id 由 API Gateway 產生 region 是 AWS 區域，以及 stage 部署 時，由您指定API。

的主機名稱部分URLapi-id.execute-api.region.amazonaws.com是指API端點。預設API端點名稱為隨機產生、難以回收，且不易於使用。

使用自訂網域名稱，您可以設定 API的主機名稱，然後選擇基本路徑 （例如 myservice），將替代方案映射至URL您的 API。例如，更易於使用API的基礎URL可能會變成：

https://api.example.com/myservice

考量事項

下列考量可能會影響您對自訂網域名稱的使用。

  • 區域自訂網域名稱可以與 RESTAPIs和 HTTP 建立關聯APIs。您可以使用 API Gateway 第 2 版APIs來建立和管理 REST 的區域自訂網域名稱APIs。

  • 對於最低TLS版本，僅支援 TLS 1.2。

  • 您必須建立或更新DNS提供者的資源記錄，才能映射至您的API端點。如果沒有此類映射，則自訂網域名稱的繫結API請求無法到達 API Gateway。

  • 您可以使用萬用字元憑證，支援幾乎無限數量的網域名稱，而不會超過預設配額。如需詳細資訊，請參閱萬用字元自訂網域名稱。

必要條件

以下是建立自訂網域名稱的先決條件。

註冊網域名稱

您必須具有已註冊的網際網路網域名稱，才能為 設定自訂網域名稱APIs。您可以使用 Amazon Route 53 或使用您選擇的第三方網域註冊商來註冊您的網際網路網域名稱。您的自訂網域名稱可以是子網域的名稱，也可以是已註冊網際網路網域的根網域 （也稱為「區域頂點」）。

您的網域名稱必須遵循 RFC 1035 規格，每個標籤最多可以有 63 個八位元組，總共可以有 255 個八位元組。

自訂網域名稱的憑證

在設定 的自訂網域名稱之前API，您必須在 中備妥 SSL/TLS 憑證ACM。如果在您建立自訂網域名稱的 AWS 區域中ACM無法使用 ，則必須將憑證匯入該區域中的API閘道。

匯入自訂網域名稱的SSL/TLS certificate, you must provide the PEM-formatted SSL/TLS憑證主體、其私有金鑰和憑證鏈。

存放在 中的每個憑證ACM都由其 識別ARN。使用 發行的憑證ACM，您不必擔心暴露任何敏感憑證詳細資訊，例如私有金鑰。若要將 AWS 受管憑證用於網域名稱，您只需參考其 ARN即可。

如果您的應用程式使用憑證釘選，有時稱為SSL釘選，以釘選ACM憑證，則應用程式在 AWS 更新憑證後可能無法連線至您的網域。如需詳細資訊，請參閱 AWS Certificate Manager 使用者指南中的憑證關聯問題。

萬用字元自訂網域名稱

使用萬用字元自訂網域名稱，您可以支援幾乎無限數目的網域名稱，而不會超過預設配額。例如，您可以為每個客戶提供其自己的網域名稱，customername.api.example.com。

若要建立萬用字元自訂網域名稱，可以指定萬用字元 (*) 作為自訂網域的第一個子網域，藉以表示根網域所有可能的子網域。

例如，萬用字元自訂網域名稱 *.example.com 會產生如 a.example.com、b.example.com 和 c.example.com 等子網域，而這些子網域全都路由至相同的網域。

萬用字元自訂網域名稱支援與 API Gateway 標準自訂網域名稱不同的組態。例如，在單一 AWS 帳戶中，您可以設定 *.example.com和 a.example.com 以不同的行為。

若要建立萬用字元自訂網域名稱，您必須提供 發行的憑證ACM，該憑證已使用 DNS或電子郵件驗證方法進行驗證。

注意

如果不同的 AWS 帳戶已建立與萬用字元自訂網域名稱衝突的自訂網域名稱，則無法建立萬用字元自訂網域名稱。例如，如果帳戶 A 已建立 a.example.com，則帳戶 B 無法建立萬用字元自訂網域名稱 *.example.com。

如果帳戶 A 和帳戶 B 共用擁有者，您可以聯絡 AWS 支援中心，以請求例外狀況。

自訂網域名稱的後續步驟

若要設定 HTTP 的自訂網域名稱API，請使用API閘道開發人員指南 REST API 一節中的文件。

首先，為您的自訂網域名稱指定憑證。如需詳細資訊，請參閱在 中備妥憑證 AWS Certificate Manager。接下來，您可以建立區域自訂網域名稱。如需詳細資訊，請參閱在 API Gateway 中設定區域自訂網域名稱。