設定自訂網域

建立 Cloud Endpoints API 入口網站時,該入口網站預設是由 Google 擁有和管理的 cloud.goog 網域託管。入口網站的預設網址格式如下,其中 YOUR_PROJECT_ID 是您部署 Endpoints 設定的目標 Google Cloud Platform (GCP) 專案:

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog

如果您希望 API 使用者使用自訂網域存取您的入口網站,您必須在網域名稱註冊商的資料中設定 Cloud Endpoints 入口網站和 DNS 設定。您在入口網站中加入自訂網域時,Endpoints 入口網站會顯示 DNS 記錄類型,以及您必須在網域名稱註冊商資料中設定的其他資訊。

本頁說明如何設定 Endpoints 入口網站以使用自訂網域。本文的範例會針對每項工作,提供完成工作所需的 Cloud Identity & Access Management 最低權限角色 (可能不只單一角色)。如要進一步瞭解 Cloud IAM 權限,請參閱以下內容:

必備條件

本指南假設:

新增自訂網域

  1. 在 Google Cloud Platform 主控台中,前往您專案的「Endpoints」>「Developer Portal」(開發人員入口網站) 頁面。

    進入 Cloud Endpoints 入口網站

  2. 按一下 [新增自訂網域]
  3. 輸入根網域或子網域名稱。
  4. 如要新增網域,請按一下 [Continue] (繼續)
  5. Endpoints 入口網站會顯示「Update your DNS records」(更新 DNS 記錄)。透過網域名稱註冊商,為「Update your DNS records」(更新 DNS 記錄) 區段中列出的所有記錄新增 DNS 記錄。

    • 如果您輸入了根網域 (例如 example.com),則「Update your DNS records」(更新 DNS 記錄) 區段會顯示包含 IP 位址的 A 記錄和 AAAA 記錄的清單。例如:

      類型 資料 別名
      A 198.51.100.0 -
      A 198.51.100.2 -
      A 198.51.100.4 -
      A 198.51.100.6 -
      AAAA 2001:db8:ffff:32::15 -
      AAAA 2001:db8:ffff:34::15 -
      AAAA 2001:db8:ffff:36::15 -
      AAAA 2001:db8:ffff:38::15 -

      為單一網域名稱新增多個 A 和 AAAA 記錄的設定步驟及術語,會因網域名稱註冊商而異動。如果您不確定,請在網域名稱註冊商的說明文件中搜尋諸如「record set」或「multiple responses」的詞彙。

    • 如果您輸入子網域 (例如 apidocs.example.com),則「Update your DNS records」(更新 DNS 記錄) 區段會顯示 CNAME,例如:

      類型 資料 別名
      CNAME ghs.googlehosted.com apidocs
  6. 按一下 [Done] (完成)

  7. 如要造訪您的入口網站,請按一下自訂網域連結。自訂網域連結最多可能需要 24 小時才會生效,實際時間取決於 DNS 記錄的傳播情況。

您必須先透過網域註冊商新增 DNS 記錄,之後 Google 才會佈建安全資料傳輸層 (SSL) 憑證。在此之前,即便使用 http://,您的入口網站也無法使用自訂網域。但是,您可以繼續使用「Endpoints」>「Developer Portal」(開發人員入口網站) 頁面上顯示的預設網址。

查看要新增至 DNS 的資訊

如要查看您需要新增 (或已經新增) 至網域名稱註冊商的資訊,請執行下列操作:

  1. 在 GCP 主控台中,前往「Endpoints」>「Developer Portal」(開發人員入口網站) 頁面。

    進入 Cloud Endpoints 入口網站

  2. 選取該 API 所屬的 GCP 專案。
  3. 在自訂網域旁邊,點選 [DNS details] (DNS 詳細資料)

刪除自訂網域

  1. 在 Google Cloud Platform 主控台中,前往您專案的「Endpoints」>「Developer Portal」(開發人員入口網站) 頁面。

    進入 Cloud Endpoints 入口網站

  2. 在自訂網域的「DNS details」(DNS 詳細資料) 旁邊,按一下 [Delete] (刪除) delete
  3. 在確認對話方塊中,點選 [Delete] (刪除)

疑難排解

新增自訂網域失敗,並出現一般錯誤。發生這種情形可能有很多原因。請先確定您的入口網站預設網址 endpointsportal.YOUR_PROJECT_ID.cloud.goog 可以運作。如果預設網址無法運作,請刪除入口網站,然後按照為您的 Endpoints API 建立入口網站中說明的步驟重新建立入口網站。

新增自訂網域失敗,但該網域仍顯示在主頁面的資料表中。此為已知問題。如要解決這個問題,請刪除自訂網域,然後再次新增該網域。

按一下 [DNS details] (DNS 詳細資料) 會顯示一個無記錄可新增的空白資料表。如果新增自訂網域失敗但該網域仍顯示在資料表中,就可能發生這種情況。如要解決這個問題,請刪除自訂網域,然後再次新增該網域。

自訂網域連結無法運作。請務必先在網域註冊商的資料中新增正確的 DNS 記錄。自訂網域最多可能需要 24 小時才會生效。

我沒有新增自訂網域的權限。您必須至少擁有專案的專案檢視者角色與 Endpoints 入口網站管理員身分。專案的專案編輯者角色也具備這些必要權限。詳情請參閱建立及管理自訂角色

我想要重複使用我的 App Engine 應用程式網域名稱。一個特定網域名稱只能供一個網路應用程式使用。您無法針對 App Engine 網路應用程式與入口網站使用相同的網域名稱。請使用專屬的網域名稱。

後續步驟

瞭解:

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
App Engine 適用的 Cloud Endpoints Frameworks
需要協助嗎?請前往我們的支援網頁