自訂網域

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

建立開發人員入口網站時，根據預設，系統會提供 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，您必須按照以下程序，在入口網站環境中建立包含必要數位憑證的 KeyStore 和別名，藉此設定 TLS。

如何設定 TLS：

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

  5. 從環境下拉式選單中選取入口網站。

  6. 按照「使用 Edge UI 建立 KeyStore 和 Truststore」的說明建立 KeyStore 和別名。

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

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

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

  • 使用自訂網域網址，並將目標端點設為預設入口網站網域的 API Proxy。API Proxy 的名稱與自訂網域名稱相符，並以底線取代半形句號。API Proxy 會部署至入口網站環境。

如何將自訂網域名稱新增至入口網站：

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

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

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

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

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

    • 查看圖示：
      • 憑證有效 憑證的有效期限超過 30 天，或是所選自訂網域可能已被使用。
      • 憑證將於 30 天後到期 憑證會在 30 天內失效。
      • 憑證已過期 憑證已過期。
    • 將遊標移到別名上，即可顯示憑證的剩餘天數。

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

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

    注意：系統會使用所選別名定義鏈結中頂層憑證的通用名稱和替代名稱，填入網域清單。
    完成所有欄位後，「自訂網域」狀態圖示會隨之更新，如下所示：
    狀態 說明
    有效狀態 KeyStore、別名和自訂網域均有效。
    認證將於 30 天後失效 憑證會在 30 天內到期。
    狀態無效 KeyStore、別名和自訂網域無效。
    此外，DNS 設定會通過驗證，「設定 DNS 狀態」圖示也會更新，如下所示：
    狀態 說明
    有效狀態 DNS 設定有效。
    狀態無效 DNS 設定無效。您必須按照設定 DNS 的說明來設定 DNS。
  5. 按一下「啟用」 (如要編輯，則請按一下「儲存」)。
    即使自訂網域或 DNS 設定無效，您還是可以啟用自訂網域。

步驟 4：設定 DNS

接下來，你必須將標準名稱 (CNAME) 記錄新增至網域 DNS，才能指向 {org_name}-portal.apigee.net。

如何確認 CNAME 值：

  1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
  2. 在頂端導覽列或到達網頁的下拉式選單中，選取「設定」。
  3. 按一下「Domains」分頁標籤。
  4. 在「Configure 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 Proxy，並使用自訂網域網址，並將目標端點設為預設入口網站網域。如果您修改或刪除與自訂網域相關聯的 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：在入口網站中新增自訂網域名稱」的步驟操作