跳到主要内容
版本:3.2.16.6

服务

一个服务代表了一个后端应用或外部的微服务。它本质上将该应用或微服务提供的所有 API 进行了分组。以下是几个和服务有关的关键关系:

  • 路由与四层路由:大多数服务与路由或四层路由是一对多的关系。每个服务只可使用一种类型,但可关联该类型的多条路由,定义传入的 API 请求如何到达服务中的对应功能。

  • 上游:服务通常与上游一一对应。上游包含负责处理服务请求的后端服务器地址。进行灰度发布时,一个服务可以暂时使用两个上游,分别指向现有版本和新版本的后端。

信息

对于熟悉 Apache APISIX 的人来说,需要注意的是,API7 企业版中的服务对象与 Apache APISIX 中的服务对象是不同的。

服务工作原理​

下图展示了已发布的 Petstore 服务。这个服务包含两条配置各异的路由。你可以使用 HTTP GET 方法获取相关数据。

服务

本示例仅将流量转发到一个上游节点。你可以根据需要为服务添加更多上游节点,以维持平稳的运行和响应,同时防止单点故障。

服务状态​

服务状态体现服务的整个 API 生命周期,分为模板、已发布和历史版本。

模板​

API7 网关使用服务模板进行版本控制。配置 API 时,可以先用模板保存配置,暂不开放访问。配置完成后,将服务模板发布到网关组,为其指定版本并开放 API。修改服务模板不会影响已发布的版本。

服务中心集中管理所有服务模板,每个模板都关联其已发布的版本。

已发布​

已发布服务提供可访问的 API。你可以从服务模板发布指定版本,也可以直接在网关组中创建服务,直接创建的服务没有版本号。已发布服务的修改会立即生效,并影响经该服务路由的流量。

一个服务可以有多个版本。每个版本有唯一的版本号,使该版本的 API 在不同网关组中保持相同的行为。同一网关组内,一个服务只能发布一个版本。在不同网关组中,可以同时运行同一服务的不同版本。

备注

直接在网关组中或通过 Ingress Controller 创建已发布服务时,API7 网关会自动创建一个服务模板,供后续进行版本控制。

历史​

API7 网关会在以下两种情况下生成历史版本。

  1. 将较新的服务版本发布到网关组。
  2. 直接修改已发布的服务,无需重新发布。

历史版本可供查阅,且不再处理 API 流量。历史版本记录过去的服务配置,便于追踪问题和回滚。与模板状态一样,历史版本无法编辑。

运行时配置​

服务的运行时配置包括以下各项。

  • 上游
  • 服务主机
  • 路径前缀
  • 跳过路径前缀

同一服务版本在不同网关组中的运行时配置可以不同。你可以直接在网关组中编辑这些配置,根据各环境的需求进行调整。

备注

以下是同一服务版本在不同网关组中的示例。

  • 测试环境中的 API URL 是 https://api7-test.ai/v1/pet,节点地址是 127.0.0.1:80。
  • 生产环境中的 API URL 是 https://api7.ai/petstore/pet,节点地址是 192.168.0.1:80。

Service ID 与 Service Template ID​

API7 网关为服务提供两个标识符,即 Service Template ID 和 Service ID。路由和四层路由也有类似的标识符。

  • 服务模板只有 Service Template ID。模板中的路由只有 Route Template ID,四层路由只有 Stream Route Template ID。
  • 网关组中的已发布服务同时拥有 Service Template ID 和 Service ID,分别用于不同用途。已发布服务中的路由同时拥有 Route Template ID 与 Route ID,四层路由同时拥有 Stream Route Template ID 与 Stream Route ID。
  • 历史版本只有 Service Template ID。历史版本中的路由只有 Route Template ID,四层路由只有 Stream Route Template ID。

Service ID 对应特定网关组中已发布的服务。通过 ADC、Admin API 或 Ingress Controller 直接创建已发布服务时,可以自定义该 ID。

ServiceID 在所属网关组内唯一。不同网关组中的已发布服务可以使用同一个 ServiceID,但不建议这样做。权限策略无法使用 Service ID。

Service Template ID 由系统自动生成,在所有网关组中唯一且不可更改,用于服务版本控制。该 ID 对应服务本身,包括服务模板、所有网关组中的已发布版本以及历史版本。你可以在权限策略中根据这个标识符分配资源。

备注

Route ID 与 Route Template ID、Stream Route ID 与 Stream Route Template ID 的区别类似。

相关阅读​