自定义您的域名

您正在查看的是 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，您需要按照以下过程在门户环境中创建包含必要数字证书的密钥库和别名，从而配置 TLS。

如需配置 TLS，请执行以下操作：

  1. 从信誉良好的证书授权机构（如 Google Trust Services）购买 TLS 证书。具体选择哪个证书授权机构由您自己决定。
  2. 登录 https://apigee.com/edge。
  3. 从用户个人资料菜单中选择您的组织。
  4. 依次选择管理 > 环境 > TLS 密钥库以显示 TLS 密钥库页面。

  5. 从环境下拉列表中选择 portal。

  6. 按照使用 Edge 界面创建密钥库和信任库中的说明创建密钥库和别名。

第 3 步：将自定义域名添加到门户

将自定义域名添加到门户时，系统会为您创建以下资源（使用与将自定义域名应用于 api.example.com 等端点相同的功能）：

  • 一台虚拟主机，该主机使用您指定的自定义域名监听端口 443。

  • 使用自定义网域网址并将目标端点设置为默认门户网域的 API 代理。API 代理的名称与自定义域名匹配，并以下划线替换英文句点。API 代理已部署到门户环境。

如需向您的门户添加自定义域名，请执行以下操作：

  1. 依次选择发布 > 门户，然后选择您的门户。
  2. 在顶部导航栏的下拉菜单中选择设置，或在着陆页上选择。
  3. 点击网域标签页。
  4. 在自定义网域下，填写以下字段。
    字段 说明
    密钥库 从下拉列表中选择一个密钥库。

    注意：系统会使用您在第 2 步在门户环境中创建的密钥库填充此列表。

    选择密钥库后，系统会显示 Alias 字段。

    别名 从下拉列表中选择有效的别名。

    注意：系统会使用您为所选密钥库创建的别名来填充此列表。此列表不包含证书链无效、Apigee 网域或信任库的密钥库。

    要确定列表中的证书何时过期，请执行以下操作：

    • 查看图标：
      • 证书有效 证书将在 30 天后过期，或者所选自定义网域可能已被使用。
      • 证书将在 30 天后过期 证书将在 30 天内过期。
      • 证书已过期 证书已过期。
    • 将光标放在别名上，即可显示证书的剩余天数。

    选择别名后，系统会显示网域字段。

    网域 从下拉列表中选择一个网域。如果您选择的是通配符别名，请输入子域名。

    注意：系统会根据所选别名所定义的链中的顶级证书的通用名称和备用名称来填充网域列表。
    填写完所有字段后，自定义网域状态图标将会更新，如下所示：
    状态 说明
    有效状态 密钥库、别名和自定义网域均有效。
    认证将在 30 天后过期 证书将在 30 天内过期。
    状态无效 密钥库、别名和自定义网域无效。
    此外，系统还会验证 DNS 配置，并更新“Configure DNS status”（配置 DNS 状态）图标，如下所示：
    状态 说明
    有效状态 DNS 配置有效。
    状态无效 DNS 配置无效。您必须按照配置 DNS 中的说明配置 DNS。
  5. 点击启用（如果您在修改，则点击保存）。
    即使自定义网域或 DNS 配置无效，您也可以启用自定义网域。

第 4 步：配置 DNS

接下来，您需要向网域 DNS 添加一条规范名称 (CNAME) 记录，以指向 {org_name}-portal.apigee.net。

要确认 CNAME 值，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 在顶部导航栏或着陆页的下拉菜单中选择设置。
  3. 点击 Domains（网域）标签页。
  4. 在 Configure DNS（配置 DNS）部分查看贵组织的 CNAME 值，如下图所示： 配置 DNS

以下是您将为上面显示的自定义网域（即 myorg 组织中的 developers.example.com 自定义网域）配置的 CNAME 记录示例：

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

问题排查：无法识别主机的代理

当您向门户添加自定义域名时，系统会默认生成一个 API 代理，该代理使用自定义网域网址，并将目标端点设置为默认门户网域。如果您修改或删除与自定义网域相关联的 API 代理，则会导致自定义网域配置失效，并且在尝试访问自定义网域网址时，您会收到 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 代理后恢复自定义网域配置，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 在顶部导航栏或着陆页的下拉菜单中选择设置。
  3. 点击 Domains（网域）标签页。
  4. 点击保存以恢复 API 代理。

更新您的证书

如需了解有关更新 TLS 证书的一般信息，请参阅更新 TLS 证书。

  1. 按照第 2 步：配置 TLS 中的步骤操作。
  2. 请按照第 3 步：将自定义域名添加到门户中的步骤操作