API閘道RESTAPIs中的自訂網域名稱 - Amazon API 网关
考量事項必要條件 萬用字元自訂網域名稱自訂網域名稱的後續步驟

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

API閘道RESTAPIs中的自訂網域名稱

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

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

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

where api-id 由API網關生成，region 是地 AWS 區，並且 stage 由您在部署API.

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

使用自訂網域名稱，您可以設定您API的主機名稱，並選擇基本路徑 (例如myservice)，將替代路徑對應URL至您的API. 例如，一個更加用戶友好的API基礎URL可以成為：

https://api.example.com/myservice

考量事項

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

  • 私人不支援自訂網域名稱APIs。

  • 您可以停用API. 用戶端仍然可以連線到您的預設端點，但會收到 403 Forbidden 狀態碼。

  • 您可以將地區自訂網域名稱與RESTAPIs和相關聯HTTPAPIs。您可以使用API閘道版本 2 APIs 來建立和管理的地區自訂網域名稱RESTAPIs。

  • 自訂網域名稱在所有 AWS 帳戶的區域中必須是唯一的。

  • 您可以在邊緣最佳化與區域端點之間遷移自訂網域名稱。

  • 您必須建立或更新DNS提供者的資源記錄，才能對應至您的API端點。如果沒有這樣的對應，繫結自訂網域名稱的API要求就無法傳送到 API Gateway。

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

  • 您可以為自訂網域名稱選擇安全性原則。如需詳細資訊，請參閱 在API閘道中為您的RESTAPI自訂網域選擇安全性原則。

  • 若要設定多個層級的API對應，您必須使用地區自訂網域名稱，並使用 TLS 1.2 安全性原則。

必要條件

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

註冊網域名稱

您必須擁有已註冊的網際網路網域名稱，才能為您的網域設定自訂網域名稱APIs。您可以使用 Amazon Route 53 或使用您選擇的第三方網域註冊商註冊您的網際網路網域名稱。您的自訂網域名稱可以是已註冊網際網路網域的子網域名稱或根網域 (也稱為「zone apex」)。

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

指定自訂網域名稱的憑證

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

若要匯入SSL/TLS憑證，您必須提供PEM格式化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為不同。

您可以使用$context.domainName和$context.domainPrefix內容變數來決定用戶端用來呼叫您的網域名稱API。若要進一步了解環境變數，請參閱 API閘道對應範本和存取記錄變數參考。

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

注意

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

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

自訂網域名稱的後續步驟

以下是自訂網域名稱的後續步驟：

後續步驟

如果這是您第一次建立自訂網域名稱，建議您先使用準備好憑證 AWS Certificate Manager，指定您的憑證，然後再在閘道中設定地區自訂API網域名稱建立區域自訂網域名稱。