自訂網域

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

建立開發人員入口網站時,系統預設會提供 Apigee 範例網域名稱,供您存取即時入口網站,格式如下:

https://orgname-portalname.apigee.io

其中 orgname 是機構名稱,portalname 則是將入口網站名稱轉換為全小寫,並移除空格和破折號。

建議您在啟動開發人員入口網站前,提供自己的自訂網域名稱。舉例來說,熱門替代方案如下:

https://developers.example.com

如要瞭解使用自訂網域搭配 SAML 識別資訊提供者時的注意事項,請參閱 使用自訂網域搭配 SAML 識別資訊提供者

自訂網域的步驟

如要自訂網域名稱,請按照下列步驟操作:

  1. 註冊網域名稱
  2. 為自訂網域建立 TLS 憑證。 建立負載平衡器時需要憑證。
  3. 判斷入口網站的預設主機名稱
  4. 建立網際網路網路端點群組 (NEG),為負載平衡器定義整合式入口網站的後端端點。
  5. 建立負載平衡器,指向網際網路 NEG,並為傳入的用戶端要求保留 IP。
  6. 在入口網站上設定自訂網域
  7. 更新 DNS,為自訂網域主機建立新記錄。

步驟 1:註冊網域名稱

如要註冊新網域,可以透過許多熱門的網域註冊網站 (例如 Google Domains) 進行。您可以自行選擇網域註冊網站。

決定網域名稱時,請考量使用者友善且容易閱讀的網址是提升搜尋引擎最佳化的重要因素,如「實作搜尋引擎最佳化 (SEO)」一文所述。

步驟 2:為自訂網域建立 TLS 憑證

使用偏好的工具 (例如 Let's Encrypt),為自訂網域建立 TLS 憑證。如需詳細資訊,請參閱:

步驟 3:判斷入口網站的預設主機名稱

如要判斷入口網站的預設主機名稱,請按照下列步驟操作:

  1. 顯示入口網站清單:

    Cloud 控制台 UI

    在 Apigee in Cloud 控制台中,前往「Distribution」>「Portals」頁面。

    前往入口網站

    傳統版 UI

    在 Apigee 使用者介面中,選取側邊導覽列中的「發布」>「入口網站」。 系統會顯示入口網站清單。

  2. 複製要建立自訂網域的入口網站「位置」欄位內容。例如:apigee-gcp-prod1-helloworld.apigee.io

    您會在下一個步驟中使用這個值。

步驟 4:建立網際網路 NEG

在這個步驟中,您會建立網際網路網路端點群組 (NEG),為負載平衡器定義整合式入口網站的後端端點。詳情請參閱「網際網路網路端點群組總覽」。

  1. 在 Google Cloud 控制台中,前往「Dashboard」(資訊主頁) 頁面,然後選取或建立 Google Cloud 專案。

    前往「資訊主頁」頁面

  2. 在導覽器中,依序選取「Compute Engine」>「網路端點群組」

  3. 按一下「建立網路端點群組」

  4. 設定下列欄位:

    欄位
    名稱 輸入網際網路 NEG 的名稱。
    網路端點群組類型 選取「網路端點群組 (網際網路)」
    新的網路端點
  5. 其餘欄位可以保留預設值。

  6. 點選「建立」

已建立網際網路 NEG。

步驟 5:建立負載平衡器

建立指向網際網路 NEG 的負載平衡器,並為傳入的用戶端要求保留 IP。

選取負載平衡器類型

  1. 前往 Google Cloud 控制台的「Load balancing」(負載平衡)頁面。

    前往「Load balancing」(負載平衡) 頁面

  2. 點選「建立負載平衡器」
  3. 在「Type of load balancer」(負載平衡器類型) 部分,選取「Application Load Balancer (HTTP/HTTPS)」(應用程式負載平衡器 (HTTP/HTTPS)),然後點選「Next」(下一步)
  4. 在「公開或內部」部分,選取「公開 (外部)」,然後點選「下一步」
  5. 在「Global or single region deployment」(全域或單一區域部署) 部分,選取「Best for global workloads」(最適合全域工作負載),然後點選「Next」(下一步)
  6. 在「Load balancer generation」(負載平衡器代別) 部分,選取「Global external Application Load Balancer」(全域外部應用程式負載平衡器),然後點選「Next」(下一步)
  7. 按一下 [設定]

設定負載平衡器

  1. 按一下每個類別,然後按照下表說明設定負載平衡器。

    類別 步驟
    前端設定

    為傳入的用戶端要求保留 IP 位址,並上傳在「步驟 2:建立傳輸層安全標準 (TLS) 憑證」中建立的傳輸層安全標準 (TLS) 憑證:

    1. 在「建立全域外部應用程式負載平衡器」部分,將游標懸停在「前端設定」上,然後按一下箭頭。
    2. 在「Name」欄位中輸入前端名稱。
    3. 從「通訊協定」下拉式選單中選取「HTTPS」
    4. 在「IP address」(IP 位址) 下拉式選單中,選取「Create IP address」(建立 IP 位址)
      系統會顯示「Reserve a new static IP address」(保留新的靜態 IP 位址) 對話方塊。
    5. 在「Name」欄位中輸入靜態 IP 位址名稱。
    6. 視需要輸入說明。
    7. 按一下「保留」
    8. 儲存預留的 IP 位址,以供設定 DNS 記錄時使用。
    9. 在「Certificate」(憑證) 下拉式選單中選取「Create a new certificate」(建立新憑證)
      「建立新憑證」視窗會滑開。
    10. 在「名稱」欄位中輸入新憑證的名稱。
    11. 在「建立模式」下方,選取「上傳我的憑證」
    12. 上傳 TLS 憑證詳細資料,包括公開金鑰、憑證鏈結和私密金鑰。
    13. 點選「建立」
    14. 按一下「完成」,即可建立新的前端 IP 和通訊埠。
    後端設定

    設定後端設定,將傳入流量導向在「步驟 4:建立網際網路網路端點群組 (NEG)」中建立的網際網路 NEG:

    1. 在「建立全域外部應用程式負載平衡器」部分,將游標懸停在「後端設定」上,然後按一下箭頭。
    2. 在「後端服務和後端 Bucket」部分,從下拉式選單中選取「後端服務」>「建立後端服務」
      「建立後端服務」視窗會隨即開啟。
    3. 在「名稱」欄位中輸入名稱。
    4. 在「Backend type」(後端類型) 下拉式選單中,選取「Internet network endpoint group」(網際網路網路端點群組)。
    5. 選取「HTTPS」做為通訊協定。
    6. 在「New backend」(新增後端) 區段中,從「Internet network endpoint group」(網際網路網路端點群組) 下拉式選單中,選取您在「步驟 4:建立網際網路網路端點群組 (NEG)」中建立的網際網路 NEG,然後按一下「Done」(完成)
    7. 取消勾選「啟用 Cloud CDN」核取方塊。
    8. 其他值則可保留預設設定。
    9. 點選「建立」
    主機與路徑規則

    設定主機與路徑規則,決定流量的導向方式:

    1. 在「建立全域外部應用程式負載平衡器」部分,將游標懸停在「主機與路徑規則」上,然後按一下箭頭。
    2. 按一下「模式」下方的「進階型主機與路徑規則 (網址重新導向與重新編寫)」
    3. 在「New host and path rule」(新增主機與路徑規則) 部分中:
      1. 在「動作」下拉式選單中,選取「將流量轉送至單一後端」
      2. 展開「附加動作 (網址重新編寫)」
      3. 在「主機重寫」欄位中,輸入您在步驟 3:判斷入口網站的預設主機名稱中複製的預設網域名稱。
      4. 在「Backend」(後端) 下拉式選單中,選取您設定的後端服務。
      5. 按一下 [完成]
  2. 在「建立全域外部應用程式負載平衡器」頁面中,按一下「建立」

步驟 6:在入口網站中設定自訂網域

如要在入口網站上設定自訂網域,請按照下列步驟操作:

  1. 顯示入口網站清單:

    Cloud 控制台 UI

    在 Apigee in Cloud 控制台中,前往「Distribution」>「Portals」頁面。

    前往入口網站

    傳統版 UI

    在 Apigee 使用者介面中,選取側邊導覽列中的「發布」>「入口網站」。 系統會顯示入口網站清單。

  2. 在清單中選取入口網站。

  3. 選取 [設定]。

  4. 按一下 [Domains] 分頁標籤。

  5. 在「網域」欄位中輸入自訂網域名稱。

  6. 按一下「啟用」

在瀏覽器中存取自訂網域,確認系統會將您導向整合式入口網站。

另請參閱「編輯自訂網域」和「停用自訂網域」。

步驟 7:更新 DNS

在 DNS 系統中,為自訂網域主機建立新記錄。

如要建立 Cloud DNS 區域,請按照「管理區域」一文中的步驟操作。請務必設定下列欄位:

欄位 說明
可用區類型 選取「公開」
區域名稱 為區域輸入適合的名稱。例如:mycompany-zone
DNS 名稱 使用您擁有的網域名稱來輸入區域的字尾,例如:mycompany.com

建立區域後,在「Zone details」(區域詳細資料) 頁面上,按一下「Add record set」(新增記錄集),然後按照「管理記錄」一文中的步驟操作。請務必設定下列欄位:

欄位 說明
DNS 名稱 指定 DNS 名稱的前置字串。您為 Cloud DNS 區域定義的後置字串也會顯示,但無法編輯。例如:developers.mycompany.com
資源記錄類型 選取「A」 (預設)。
存留時間 設為所需值,或保留預設值 5
存留時間單位 設定所需值,或保留預設值「分鐘」
IPv4 位址 輸入您在建立負載平衡器時預留的外部 IP 位址。

編輯入口網站的自訂網域

如要編輯入口網站的自訂網域,請按照下列步驟操作:

  1. 顯示入口網站清單:

    Cloud 控制台 UI

    在 Apigee in Cloud 控制台中,前往「Distribution」>「Portals」頁面。

    前往入口網站

    傳統版 UI

    在 Apigee 使用者介面中,選取側邊導覽列中的「發布」>「入口網站」。 系統會顯示入口網站清單。

  2. 在清單中選取入口網站。

  3. 選取 [設定]。

  4. 按一下 [Domains] 分頁標籤。

  5. 編輯自訂網域資訊。

  6. 按一下 [儲存]

停用入口網站的自訂網域

如要停用入口網站的自訂網域名稱,請按照下列步驟操作:

  1. 顯示入口網站清單:

    Cloud 控制台 UI

    在 Apigee in Cloud 控制台中,前往「Distribution」>「Portals」頁面。

    前往入口網站

    傳統版 UI

    在 Apigee 使用者介面中,選取側邊導覽列中的「發布」>「入口網站」。 系統會顯示入口網站清單。

  2. 在清單中選取入口網站。

  3. 選取 [設定]。

  4. 按一下 [Domains] 分頁標籤。

  5. 按一下「停用」

  6. 在提示中按一下「停用」,確認要停用這項功能。

自訂網域已停用,且欄位已清除。