自訂網域

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info

建立開發人員入口網站時，系統會預設提供 Apigee 範例網域名稱，讓您以以下格式存取實際的入口網站：

https://orgname-portalname.apigee.io

其中 orgname 是機構名稱，portalname 則是使用轉換為全小寫並移除空格和破折號的入口網站名稱定義。

建議您在推出開發人員入口網站前，先提供自訂網域名稱。例如，以下是常見的替代做法：

https://developers.example.com

如要瞭解在 SAML 身分識別資訊提供者中使用自訂網域的注意事項，請參閱「在 SAML 提供者中使用自訂網域」。

以下各節說明如何自訂網域。

自訂網域名稱 (Apigee Edge)

如要使用 Apigee Edge 整合式入口網自訂網域名稱，請執行下列步驟：

  1. 註冊網域名稱。
  2. 設定 TLS。
  3. 在入口網站中新增自訂網域名稱。
  4. 設定 DNS。

新增自訂網域後，您可以編輯或停用該網域。如需疑難排解問題的相關說明，請參閱「排解自訂網域問題」。

步驟 1：註冊網域名稱

如果您需要註冊新網域，可以使用許多熱門的網域註冊網站，例如 Google Domains。您可以選擇要使用哪個網域註冊網站。

決定網域名稱時，請考量到「實施搜尋引擎最佳化 (SEO)」一文所述，使用者友善且人類可讀的網址是改善搜尋引擎最佳化的關鍵要素。

步驟 2：設定 TLS

如要支援 HTTPS，您必須在入口網站環境中建立包含必要數位憑證的金鑰庫和別名，如以下程序所述，藉此設定 TLS。

如要設定 TLS，請按照下列步驟操作：

  1. 向 Google Trust Services 等信譽良好的憑證授權單位購買 TLS 憑證。您可以自行選擇要使用的憑證授權單位。
  2. 登入 https://apigee.com/edge。
  3. 從使用者個人資料選單中選取機構。
  4. 依序選取「Admin」>「Environment」>「TLS KeyStores」，查看傳輸層安全標準 (TLS) KeyStore 頁面。

  5. 在環境下拉式選單中選取「Portal」。

  6. 按照使用 Edge UI 建立 KeyStore 和信任存放區的說明，建立 KeyStore 和別名。

步驟 3：在入口網站中新增自訂網域名稱

在入口網站中加入自訂網域名稱時，系統會使用相同的功能，為您建立下列資源 (例如將自訂網域名稱套用至 api.example.com 等端點)：

  • 虛擬主機 (使用您指定的自訂網域名稱監聽通訊埠 443)。

  • 使用自訂網域網址的 API 代理程式，其目標端點設為預設入口網站網域。API Proxy 的名稱與自訂網域名稱相符，但點號會替換為底線。系統會將 API Proxy 部署至入口網站環境。

如要為入口網站新增自訂網域名稱，請按照下列步驟操作：

  1. 依序選取「發布」>「入口網站」，然後選取入口網站。
  2. 在頂端導覽列或到達網頁的下拉式選單中，選取「設定」。
  3. 按一下「Domains」分頁標籤。
  4. 在「自訂網域」之下填寫下列欄位。
    欄位 說明
    KeyStore 從下拉式清單中選取金鑰庫。

    注意：系統會使用您在步驟 2 中於入口網站環境中建立的 KeyStore 填入清單。

    選取 KeyStore 後，系統會顯示「別名」欄位。
    別名 從下拉式清單中選取有效的別名。

    注意：系統會使用您為所選 KeyStore 建立的別名填入清單。此清單不包含含有無效憑證鏈結的 KeyStore、Apigee 網域或信任存放區。

    如何判斷清單上的憑證到期時間：

    • 查看圖示：
      • 憑證有效 憑證到期日超過 30 天，或是所選自訂網域可能已在使用中。
      • 憑證將於 30 天後到期 證書將於 30 天內到期。
      • 憑證已過期 憑證已過期。
    • 將游標懸停在別名上，即可查看憑證的剩餘效期天數。

    選取別名後，系統會顯示「網域」欄位。

    網域 從下拉式清單中選取網域。如果您選取萬用字元別名，請輸入子網域。

    注意：系統會使用所選別名定義鏈結中頂層憑證的常用名稱和替代名稱，填入網域清單。
    填妥所有欄位後，「自訂網域」狀態圖示會更新為下列狀態：
    狀態 說明
    有效狀態 KeyStore、別名和自訂網域均有效。
    認證將於 30 天後到期 證書將於 30 天內到期。
    狀態無效 金鑰庫、別名和自訂網域無效。
    此外，系統會驗證 DNS 設定，並更新「Configure DNS」狀態圖示，如下所示：
    狀態 說明
    有效狀態 DNS 設定有效。
    狀態無效 DNS 設定無效。您必須設定 DNS，如「設定 DNS」一文所述。
  5. 按一下「啟用」 (如果您正在編輯，請按一下「儲存」)。
    即使自訂網域或 DNS 設定無效，您仍可啟用自訂網域。

步驟 4：設定 DNS

接下來，您需要在網域 DNS 中新增正規名稱 (CNAME) 記錄，指向 {org_name}-portal.apigee.net。

如要確認 CNAME 值，請按照下列步驟操作：

  1. 依序選取「發布」>「入口網站」，然後選取入口網站。
  2. 在頂端導覽列或到達網頁的下拉式選單中，選取「設定」。
  3. 按一下「Domains」分頁標籤。
  4. 在「設定 DNS」部分查看貴機構的 CNAME 值，如以下圖所示： 設定 DNS

以下提供 CNAME 記錄範例，您可以為上述自訂網域 (也就是 myorg 機構中的 developers.example.com 自訂網域) 設定這類記錄：

developers.example.com. CNAME myorg-portal.apigee.net.

排解自訂網域問題

以下各節提供自訂網域的疑難排解建議。

排解問題：使用 dig 驗證網域的 DNS 設定

在網域 DNS 更新並加入 CNAME 記錄後，相關變更需要一段時間才會在全球的其他 DNS 伺服器生效。您可以使用 dig 查詢網域 DNS 伺服器，確認 CNAME 記錄設定正確無誤，即使尚未完全複製到其他 DNS 伺服器也一樣。

舉例來說，下列 dig 指令會查詢網域 DNS 伺服器。在指令輸出內容中，ANSWER SECTION 包含 CNAME 記錄項目。

$ dig @your.domain.dns developer.mycompany.com
; <<>> DiG 9.8.3-P1 <<>> @your.domain.dns developer.mycompany.com
; (1 server found)
;; global options:  cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 41356
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 0
;; WARNING: recursion requested but not available

;; QUESTION SECTION:
;developer.mycompany.com.       IN  A

;; ANSWER SECTION:
developer.mycompany.com.    29  IN  CNAME   myorg-portal.apigee.net.

;; Query time: 141 msec
;; SERVER: 192.168.1.254#53(192.168.1.254)
;; WHEN: Mon Mar 20 16:41:59 2017
;; MSG SIZE  rcvd: 136

疑難排解：無法識別主機的 Proxy

在入口網站中新增自訂網域名稱時，系統會預設產生 API 代理程式，該代理程式會使用自訂網域網址，並將目標端點設為預設入口網站網域。如果您修改或刪除與自訂網域相關聯的 API Proxy，自訂網域設定就會失效，且嘗試存取自訂網域網址時會收到 Unable to identify proxy for host 錯誤訊息。例如：


{"fault":{"faultstring":"Unable to identify proxy for host: developers.mycompany.com:443 and url: \/","detail":{"errorcode":"messaging.adaptors.http.flow.ApplicationNotFound"}}}

如何在 API Proxy 遭到修改或刪除的情況下還原自訂網域設定：

  1. 依序選取「發布」>「入口網站」，然後選取入口網站。
  2. 在頂端導覽列或到達網頁的下拉式選單中，選取「設定」。
  3. 按一下「Domains」分頁標籤。
  4. 按一下「儲存」，即可還原 API Proxy。

更新憑證

如需更新 TLS 憑證的一般資訊，請參閱「更新 TLS 憑證」。

  1. 請按照「步驟 2：設定 TLS」中的步驟操作。
  2. 按照「步驟 3：為入口網站新增自訂網域名稱」一節的步驟操作。