您正在查看 Apigee Edge 文档。
请查看 Apigee X 文档。
在 Edge 中,路由器会处理所有传入的 API 流量。这意味着,向 API 代理发出的所有 HTTP 和 HTTPS 请求均由边缘路由器处理。
虚拟主机可让您在服务器上托管多个域名。对于 Edge,服务器与 Edge 路由器相对应。通过在路由器上定义多个虚拟主机,路由器可以处理对多个域名的 API 请求。
Edge 中的虚拟主机定义了访问协议(HTTP 或 HTTPS)、开放的路由器端口和主机别名。主机别名通常是映射到路由器 IP 地址的 DNS 域名。
例如,下图显示了一个具有两个虚拟主机定义的路由器:
第一个虚拟主机处理网域 domainName1 上的 HTTPS 请求,第二个虚拟主机处理 domainName2 上的 HTTP 请求。
对于向 API 代理发出的请求,路由器会将传入请求的 Host
标头与所有虚拟主机定义的主机别名列表进行比较,以确定哪个虚拟主机会处理该请求。
关于虚拟主机定义
虚拟主机包含以下信息:
- 虚拟主机的内部名称。您可以使用该名称在 API 代理中以及配置虚拟主机时引用虚拟主机。
- 虚拟主机的主机别名。通常情况下,主机别名是映射到路由器上的 IP 地址的 DNS 域名。API 代理请求的
Host
标头必须包含虚拟主机的主机别名。 - 路由器上的开放端口。
- 是否启用 TLS(HTTPS 访问)(HTTP 访问)。
例如,您可以在创建虚拟主机时指定以下信息:
- name = myvhost
- host host = apis.acme.com
- 端口 = 443
- TLS 已启用
根据上述针对虚拟主机的设置,向 API 代理发送的请求使用以下形式:
https://apis.acme.com/{proxy-base-path}/{resource-path}
其中:
- {proxy-base-path} 会在您创建 API 代理时定义,对于每个 API 代理都是唯一的。例如:
https://apis.acme.com/characters
- {resource-path}可通过 API 代理访问的资源的路径。例如:
https://apis.acme.com/characters/coyote https://apis.acme.com/characters/roadrunner
。
关于适用于 Edge 的 Cloud 虚拟主机
每个 Edge 组织都会自动包含两个环境(test
和 prod
)、每个环境中的两个虚拟主机(默认和安全)以及每个主机别名的 DNS 记录。
每个 Apigee 提供的虚拟主机的主机别名包含组织和环境的名称,如下表所示:
环境 | 虚拟主机名 | 主机别名 | Port(端口) | 已启用 TLS |
---|---|---|---|---|
prod | 默认 | {org-name}-prod.apigee.net |
80 | 否 |
安全 | {org-name}-prod.apigee.net |
443 | 兼容 | |
测试 | 默认 | {org-name}-test.apigee.net |
80 | 否 |
安全 | {org-name}-test.apigee.net |
443 | 兼容 |
例如,prod
环境中名为“myorg
”的组织的默认域名为“myorg-prod.apigee.net
”。因此,如需访问该组织中的 API 代理,请使用采用以下格式的网址:
http://myorg-prod.apigee.net/{proxy-base-path}/{resource-path} https://myorg-prod.apigee.net/{proxy-base-path}/{resource-path}
Apigee 付费方案:您可能想向客户显示包含“apigee.net”的域名。您可以使用 DNS 条目和 CNAME 记录将域名映射到 Edge 上的组织。您还必须创建一个虚拟主机,并将主机别名设置为该域名。这样一来,开发者便可以通过贵公司专属的域名访问您的 API。
以下是 Edge 中的自定义网域示例:
https://apis.acme.com/{proxy-base-path}/{resource-path}
关于适用于私有云的 Edge 中的虚拟主机
安装 Apigee Edge for Private Cloud 时,系统不会为您创建任何默认组织、环境或虚拟主机。完成 Edge 安装过程后,您的第一个操作通常通过“初始配置”流程创建组织、环境和虚拟主机。
如需执行初始配置,请在边缘管理服务器节点上运行以下命令:
/opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile
其中,configFile 包含创建用户、组织、环境和虚拟主机所需的信息。
例如,您创建:
- 您选择担任组织管理员的用户
- 名为“
example
”的组织 - 组织中名为“
prod
”的环境 - 名为
default
的环境中的虚拟主机,允许端口 9001 的 HTTP 访问 - 用于访问路由器的 DNS 名称的主机别名,或虚拟主机的路由器和端口的 IP 地址(格式为
IP:9001
)。
以后,您可以将任意数量的组织、环境和虚拟主机添加到本地版本的 Edge。如需了解详情,请参阅以下主题:
虚拟主机会在边缘路由器上打开。因此,您必须确保为虚拟主机指定的端口在路由器上处于打开状态。您可以使用以下形式的命令打开端口:
iptables -A INPUT -m state --state NEW -m tcp -p tcp --dport 9001 -j ACCEPT --verbose
运行该命令后,您可以使用以下网址的网址访问 API:
http://<router-ip>:9001/{proxy-base-path}/{resource-path}
通常情况下,您无需向具有 IP 地址和端口号的客户发布 API。而是为路由器和端口定义 DNS 条目。例如:
http://myAPI.myCo.com/{proxy-base-path}/{resource-path}
定义 DNS 条目时,您还必须使用与 DNS 条目的域名匹配的主机别名来创建虚拟主机。在上例中,您可以在创建虚拟主机时指定 myAPI.myCo.com 的主机别名。
主机别名和 DNS 名称简介
您为虚拟主机设置的其中一个属性是主机别名。主机别名通常是虚拟主机的 DNS 名称。如何设置主机别名取决于您的 Edge 安装类型:Cloud 还是私有云。
在 Edge 中用于 Cloud 的主机别名和 DNS 名称
在 Edge for Cloud 中,当您首次创建 Edge 组织时,Apigee 会自动创建两个环境(test
和 prod
)、每个环境中的两个虚拟主机(默认和安全)以及每个虚拟主机的 DNS 记录。
虚拟主机的主机别名包含组织和环境的名称。 因此,通过虚拟主机发送的请求的格式如下:
http://{org-name}-prod.apigee.net/{proxy-base-path}/{resource-path}
https://{org-name}-prod.apigee.net/{proxy-base-path}/{resource-path}
http://{org-name}-test.apigee.net/{proxy-base-path}/{resource-path}
https://{org-name}-test.apigee.net/{proxy-base-path}/{resource-path}
通常情况下,您需要创建使用您的域名的虚拟主机,而不使用默认的 apigee.net
网域。为此,您必须先创建自己的 DNS 条目和 CNAME 记录。
下图显示了 Edge 处理 API 请求的常见配置:
在此示例中:
- api.acme.com 是您所需的域名。
- 您需要定义一个 DNS 条目和 CNAME 记录,以将 api.acme.com 指向 acme-prod.apigee.net。
- 该请求包含
Host
标头,路由器用它来确定处理请求的虚拟主机。
在此示例中,您可以在虚拟主机定义中指定以下信息:
- name = myvhost
- host host = apis.acme.com
- 端口 = 443
- 启用 TLS 访问权限
如需了解详情,请参阅为 Cloud 配置虚拟主机。
在用于私有云的 Edge 中托管主机别名和 DNS 名称
与 Cloud Edge 一样,您可以使用自己的域名作为主机别名来创建虚拟主机。然后,您可以创建自己的 DNS 条目和 CNAME 记录来访问这些虚拟主机。
Cloud 与私有云之间的区别之一在于,在 Cloud Apigee 中,系统会自动为贵组织创建 DNS 名称,格式如下:
- name=default:
http://{org-name}-{env-name}.apigee.net
(路由器端口 80) - name=secure:
https://{org-name}-{env-name}.apigee.net
(路由器端口 443)
在 Private Cloud 的 Edge 中,您必须创建路由器的 IP 地址和端口的 DNS 条目。
例如,您可以在虚拟主机定义中指定此信息:
- name = myvhost
- host host = apis.acme.com
- 端口 = 9001
- 启用 TLS 访问权限
下图显示了 Edge 处理 API 请求的常见配置:
在此示例中:
- api.acme.com 是您所需的域名。
- 您需要定义一个 DNS 条目和 CNAME 记录,以将 api.acme.com 指向路由器的 IP 地址和端口。
- 该请求包含
Host
标头,路由器用它来确定处理请求的虚拟主机。
如需了解详情,请参阅为私有云配置虚拟主机。
主机别名和通配符
您可以在主机别名中包含“*”通配符。“*”通配符只能在主机别名的开头(前面的第一个“.”)开头,不能与其他字符混合。
以下是使用通配符的有效主机别名的示例:
*.example.com
以下示例无效:
www.*.example.com w*.example.com
在虚拟主机别名中使用通配符可让 API 代理处理发送到多个子网域(例如 alpha.example.com
、beta.example.com
或 live.example.com
)的调用。使用通配符别名还有助于减少每个环境中的虚拟主机数量,以避免超出产品限制,因为具有通配符的虚拟主机仅计为一个虚拟主机。
虚拟主机的 TLS 证书的 CN 名称中必须包含匹配的通配符。
例如,*.example.com
。
虚拟主机属性简介
在 Edge 中,虚拟主机由 XML 对象表示。例如,以下 XML 对象定义了一个虚拟主机:
<VirtualHost name="vhostName"> <HostAliases> <HostAlias>hostAlias</HostAlias> </HostAliases> <Interfaces> <!-- Private Cloud only --> <Interface>interfaceName</Interface> <Port>portNumber</Port> <BaseURL>http://myCo.com<</BaseUrl> <OCSPStapling>off</OCSPStapling> <RetryOptions/> <SSLInfo> <Enabled>trueFalse</Enabled> <ClientAuthEnabled>trueFalse</ClientAuthEnabled> <KeyStore>ref://keystoreRef</KeyStore> <KeyAlias>keyAlias</KeyAlias> <TrustStore>ref://truststoreRef</TrustStore> <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors> </SSLInfo> <Properties> <Property name="proxy_read_timeout">timeout</Property> <Property name="keepalive_timeout">timeout</Property> <Property name="proxy_request_buffering">onOff</Property> <Property name="proxy_buffering">onOff</Property> <Property name="ssl_protocols">protocolList</Property> <Property name="ssl_ciphers">cipherList</Property> </Properties> </VirtualHost>
您可以设置的属性列表取决于您使用的是适用于云端的 Edge 还是私有云的 Edge。如果您使用 Edge 用于私有云,则可用属性列表还取决于您的 Edge 版本。有关虚拟主机所有属性的完整说明,请参阅虚拟主机属性参考文档。
如需详细了解如何为特定版本的 Edge 创建虚拟主机,请参阅以下内容: