自定义您的网域

您正在查看 Apigee X 文档。
查看 Apigee Edge 文档。

默认情况下,当您创建开发者门户时,系统向您提供的用于访问实时门户的 Apigee 域名示例采用如下格式:

https://orgname-portalname.apigee.io

其中,orgname 是组织名称,portalname 使用全部转换为小写并移除空格和短划线的门户名称定义。

在启动开发者门户之前,建议您提供自己的自定义域名。例如,常见的替代方式是:

https://developers.example.com

如需了解将自定义网域与 SAML 身份提供商搭配使用的注意事项,请参阅将自定义网域与 SAML 身份提供商搭配使用

自定义网域的步骤

如需自定义您的域名,请执行以下步骤:

  1. 注册您的域名
  2. 为您的自定义网域创建 TLS 证书。创建负载平衡器时,您需要使用证书。
  3. 确定门户的默认主机名
  4. 创建互联网网络端点组 (NEG) 为负载平衡器的集成门户定义后端端点。
  5. 创建一个负载平衡器来指向互联网网络端点组,并为传入的客户端请求预留 IP。
  6. 在您的门户上配置自定义网域
  7. 更新您的 DNS 为自定义域名托管服务商创建一条新记录。

第 1 步:注册您的域名

如果您需要注册新网域,可以访问多个热门的网域注册网站,例如 Google Domains。您可以自行决定使用哪个网域注册网站。

在决定您的域名时,请考虑易于阅读且便于用户理解的网址是改进搜索引擎优化的关键因素,如实现搜索引擎优化 (SEO) 中所述。

第 2 步:为您的自定义网域创建 TLS 证书

使用您的首选工具(如 Let's Encrypt)为您的自定义网域创建 TLS 证书。有关详情,请参阅:

第 3 步:确定门户的默认主机名

要确定门户的默认主机名,请执行以下操作:

  1. 在 Apigee 界面中,选择侧边导航栏中的 Publish > Portal。此时会显示门户列表。
  2. 复制要为其创建自定义网域的门户的位置字段中的内容。突出显示位置字段的门户项目

    下一步中您需要用到该值。

第 4 步:创建互联网 NEG

在此步骤中,您将创建一个互联网网络端点组 (NEG) 来为负载平衡器的集成门户定义后端端点。如需了解详情,请参阅互联网网络端点组概览

  1. 在 Google Cloud Console 中,转到信息中心页面,然后选择或创建 Google Cloud 项目。

    转到“信息中心”页面

  2. 在导航器中依次选择 Compute Engine > 网络端点组

  3. 点击创建网络端点组

  4. 配置以下字段:

    字段
    姓名 输入互联网网络端点组的名称。
    网络端点组类型 选择网络端点组(互联网)
    新网络端点
  5. 您可以将其余字段保留默认值。

  6. 点击创建

互联网 NEG 已创建。

第 5 步:创建负载平衡器

创建一个负载平衡器来指向互联网网络端点组,并为传入的客户端请求预留 IP。

如需创建负载平衡器,请执行以下操作:

  1. Google Cloud Console 中,在导航器中选择网络服务 > 负载平衡

  2. 点击创建负载平衡器

  3. HTTP(S) 负载平衡下,点击开始配置

  4. 选择从互联网到我的虚拟机,然后点击继续

  5. 名称字段中,输入负载平衡器的名称。

  6. 点击每个类别并按照下表所述配置负载平衡器。

    类别 步骤
    后端配置

    配置后端配置,将传入的流量定向到第 4 步:创建互联网网络端点组 (NEG) 中创建的互联网 NEG:

    1. 新建 HTTP(S) 负载平衡器部分中,将光标放在后端配置上,然后点击箭头。
    2. 后端服务和后端存储分区部分,从下拉菜单中选择后端服务 > 创建后端服务
      “创建后端服务”窗口已打开。
    3. 名称字段中输入名称。
    4. 后端类型下拉列表中,选择互联网网络端点组
    5. 新后端部分,选择您在第 4 步:创建互联网网络端点组 (NEG)包含于互联网网络端点组下拉菜单中,然后点击完成
    6. 您可以将所有其他值保留为默认值。
    7. 点击创建
    主机和路径规则

    配置主机和路径规则以确定流量的引导方式:

    1. 新建 HTTP(S) 负载平衡器部分,将光标悬停在主机和路径规则上,然后点击箭头。
    2. 点击模式下的高级主机和路径规则(网址重定向、网址重写)
    3. 新建主机和路径规则部分中:
      1. 操作下拉菜单中选择将流量路由到单个后端
      2. 展开附加操作(网址重写)
      3. 主机重写字段中输入您在第 3 步:确定门户的默认主机名中复制的默认域名。
      4. 选择您在后端下拉列表中配置的后端服务。
      5. 点击完成
    前端配置

    为传入的客户端请求保留 IP 地址,并上传第 2 步:创建 TLS 证书中创建的 TLS 证书:

    1. 新建 HTTP(S) 负载平衡器部分中,将光标放在前端配置上,然后点击箭头。
    2. 名称字段中输入前端的名称。
    3. 协议下拉菜单中选择 HTTPS
    4. IP 地址下拉菜单中选择创建 IP 地址
      此时将显示“预留新的静态 IP 地址”对话框。
    5. 名称字段中输入静态 IP 地址的名称。
    6. (可选)输入说明。
    7. 点击预留
    8. 存储预留 IP 地址,以供设置 DNS 记录时使用。
    9. 证书下拉菜单中选择创建新证书
      系统会打开“创建新证书”窗口幻灯片。
    10. 名称字段中输入新证书的名称。
    11. 创建模式下选择上传我的证书
    12. 上传您的 TLS 证书详细信息,包括公钥、证书链和私钥。
    13. 点击创建
    14. 点击完成以创建新的前端 IP 和端口。
  7. 点击新建 HTTP(S) 负载平衡器页面上的创建

第 6 步:在您的门户上配置自定义网域

如需在您的门户上配置自定义网域,请执行以下操作:

  1. 在 Apigee 界面中,选择侧边导航栏中的 Publish > Portal
    此时会显示门户列表。
  2. 从列表中选择您的门户。
  3. 在着陆页或顶部导航栏的下拉菜单中选择设置
  4. 点击 Domains(网域)标签页。
  5. Domain(网域)字段中输入您的自定义域名。
  6. 点击启用

测试当您在浏览器访问自定义网域时将定向到集成门户。

另请参阅修改自定义网域停用自定义网域

第 7 步:更新您的 DNS

在您的 DNS 系统中,为自定义域名托管服务商创建一条新记录。

如需创建 Cloud DNS 区域,请执行管理区域中介绍的步骤。确保按如下所述方式配置以下字段:

字段 说明
区域类型 选择公开
地区名称 为该区域输入一个有意义的名称。例如:mycompany-zone
DNS 名称 使用一个您拥有的域名输入该区域的后缀。例如:mycompany.com

创建区域后,请在“区域详细信息”页面上点击添加记录集,然后执行管理记录中介绍的步骤。确保按如下所述方式配置以下字段:

字段 说明
DNS 名称 指定 DNS 名称的前缀。系统还会显示您为 Cloud DNS 区域定义的后缀,但此后缀无法修改。例如:developers.mycompany.com
资源记录类型 选择 A(默认)。
TTL 设置为所需值或保留设置为 5(默认)。
TTL 单位 设置为所需值或保留设置为分钟(默认)。
IPv4 地址 输入您在创建负载平衡器时保留的外部 IP 地址。

在您的门户上修改自定义网域

要修改门户的自定义网域,请执行以下操作:

  1. 在 Apigee 界面中,选择侧边导航栏中的 Publish > Portal
    此时会显示门户列表。
  2. 从列表中选择您的门户。
  3. 在顶部导航栏或着陆页的下拉菜单中选择设置
  4. 点击网域标签页。
  5. 修改自定义网域信息。
  6. 点击保存

在您的门户上停用自定义网域

要在您的门户上停用自定义域名,请执行以下操作:

  1. 在 Apigee 界面中,选择侧边导航栏中的 Publish > Portal。此时会显示门户列表。
  2. 从列表中选择您的门户。
  3. 在顶部导航栏或着陆页的下拉菜单中选择设置
  4. 点击网域标签页。
  5. 点击停用
  6. 点击提示中的停用以确认操作。

自定义网域已停用且字段已被清除。