自訂網域

本頁適用於 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」頁面。

    前往「Portals」

    傳統版 UI

    在 Apigee UI 中,依序選取側邊導覽列中的「Publish」>「Portals」。 畫面上會顯示入口網站清單。

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

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

步驟 4:建立網際網路網路端點群組

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

  1. 在 Google Cloud 控制台中,前往「Dashboard」頁面,選取或建立 Google Cloud 專案。

    前往「Dashboard」(資訊主頁) 頁面

  2. 在導覽面板中,依序選取「Compute Engine」>「Network Endpoint Groups」

  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. 在「全域或單一區域部署」部分,選取「最適合全域工作負載」,然後點選「Next」
  6. 在「Load balancer generation」(負載平衡器代別) 部分,選取「Global external Application Load Balancer」(全域外部應用程式負載平衡器),然後點選「Next」(下一步)
  7. 按一下 [設定]

設定負載平衡器

  1. 按一下各類別,然後按照下表所述設定負載平衡器。

    類別 步驟
    前端設定

    為傳入的用戶端要求保留 IP 位址,並上傳在步驟 2:建立 TLS 憑證中建立的 TLS 憑證:

    1. 在「Create global external Application Load Balancer」部分,將游標移至「Frontend configuration」,然後按一下箭頭。
    2. 在「名稱」欄位中輸入前端名稱。
    3. 在「Protocol」下拉式選單中,選取「HTTPS」
    4. 在「IP 位址」下拉式選單中,選取「建立 IP 位址」
      「保留新的靜態 IP 位址」對話方塊隨即顯示。
    5. 在「名稱」欄位中輸入靜態 IP 位址的名稱。
    6. 視需要輸入說明。
    7. 按一下「保留」
    8. 儲存預留的 IP 位址,以便在設定 DNS 記錄時使用。
    9. 在「Certificate」下拉式選單中選取「Create a new certificate」
      「建立新憑證」視窗會滑動開啟。
    10. 在「名稱」欄位中輸入新憑證的名稱。
    11. 選取「建立模式」下方的「上傳我的憑證」
    12. 上傳 TLS 憑證詳細資料,包括公用金鑰、憑證鏈結和私密金鑰。
    13. 按一下 [建立]。
    14. 按一下「完成」即可建立新的前端 IP 和通訊埠。
    後端設定

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

    1. 在「Create global external Application Load Balancer」(建立全域外部應用程式負載平衡器) 部分,將滑鼠游標移至「Backend configuration」(後端設定),然後按一下箭頭。
    2. 在「後端服務和後端值區」部分,從下拉式選單中選取「後端服務」>「建立後端服務」
      「Create backend service」(建立後端服務) 視窗會滑動開啟。
    3. 在「名稱」欄位中輸入名稱。
    4. 在「後端類型」下拉式選單中,選取「網際網路網路端點群組」
    5. 選取「HTTPS」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. 在「後端」下拉式選單中,選取您設定的後端服務。
      5. 按一下 [完成]
  2. 在「建立全域外部應用程式負載平衡器」頁面中,按一下「建立」

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

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

  1. 顯示入口網站清單:

    Cloud 控制台 UI

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

    前往「Portals」

    傳統版 UI

    在 Apigee UI 中,依序選取側邊導覽列中的「Publish」>「Portals」。 畫面上會顯示入口網站清單。

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

  3. 選取 [設定]。

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

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

  6. 按一下「啟用」

測試在瀏覽器中存取自訂網域時,是否會導向整合的入口網站。

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

步驟 7:更新 DNS

在 DNS 系統中,為自訂網域代管服務建立新記錄。

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

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

建立可用區後,請在「可用區詳細資料」頁面中按一下「新增記錄集」,然後按照「管理記錄」一文所述的步驟操作。請務必設定下列欄位:

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

編輯入口網站的自訂網域

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

  1. 顯示入口網站清單:

    Cloud 控制台 UI

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

    前往「Portals」

    傳統版 UI

    在 Apigee UI 中,依序選取側邊導覽列中的「Publish」>「Portals」。 畫面上會顯示入口網站清單。

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

  3. 選取 [設定]。

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

  5. 編輯自訂網域資訊。

  6. 按一下 [儲存]

在入口網站上停用自訂網域

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

  1. 顯示入口網站清單:

    Cloud 控制台 UI

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

    前往「Portals」

    傳統版 UI

    在 Apigee UI 中,依序選取側邊導覽列中的「Publish」>「Portals」。 畫面上會顯示入口網站清單。

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

  3. 選取 [設定]。

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

  5. 按一下「停用」

  6. 在提示中點選「停用」,確認要執行的操作。

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