单元化部署(操作指南)

最近更新时间: 2026-03-13 09:03:00

操作场景

该任务指导您在 TSF 控制台上创建单元化规则并使用单元化功能。

前提要求

  1. 已在 TCUA 单元化管理-架构规划,添加该微服务网关作为单元化网关。
  2. 已创建单元化规则并推送成功。

操作步骤

步骤一:查看单元化配置

  1. 登录 TSF 控制台。
  2. 在左侧菜单栏选择【微服务网关】>【网关管理】。
  3. 在【网关管理】界面,单击目标网关的ID/名称,进入【基本信息】页面。
  4. 在【单元化配置】模块,查看单元化部署为已启用,存在已生效单元规则。

步骤二:查看单元化规则

单元化规则用于定义单元化请求的转发路径。

  1. 在【网关管理】界面,单击目标网关的ID/名称,进入【基本信息】页面。
  2. 在【单元化规则】页签,查看已生效的单元化规则。
  3. 点击单元化规则的 ID/名称,进入详情页,查看单元化规则的基本信息、标签配置和规则配置。

注意:

  1. 单元化管理平台下发的规则不支持修改和删除,如需变更,请前往单元化管理平台操作。
  2. 一个网关下可存在多条单元化规则,但同时只能有一条规则生效,当一条规则生效时,其他正在生效的规则将默认关闭。

步骤三:创建分组并导入 API

  1. 在【分组管理】页面,单击【新建分组】,填写分组信息。
  • 分组名称: 最长为60个字符,只能包含小写字母、数字及分隔符(_-),且不能以分隔符开头或结尾。
  • 访问 context:context 是用户访问网关管理的某一个 API 的路径的路径参数。以“/”开头,不能为空。
  • 托管 API 类型:选择微服务API,单元化部署场景不支持托管外部API。
  • 鉴权类型:密钥鉴权或无鉴权。当选择密钥对鉴权时,请求参数中不带正确的 SecretId 和签名的访问会被拒绝。
    img
  1. 单击【保存&下一步】,将分组与微服务网关应用的部署组进行绑定。

    注意:

    • 当微服务网关作为微服务内部调用网关时,建议绑定微服务下全部部署组。当微服务网关作为外部与微服务间调用的外部网关时,可以选择将某个分组与某个或全部部署组绑定,通过访问部署组域名或IP来访问网关托管的API。
    • 只有将网关应用的部署组与分组绑定后,才能保证访问部署组 IP 后与对应 API path 访问畅通。
    • 此处分组绑定的部署组是微服务网关应用的部署组,也就是用作部署网关的节点所在的部署组。并非后端微服务的部署组。
    • 单个微服务网关部署组不能绑定多个 context 相同的分组。
  2. 在【API管理】页面,选择目标分组,单击【新建API】,选择需要导入 API 的业务系统、命名空间和微服务,将API导入分组。

    注意:

    单元部署化场景下,只需要导入业务系统中一个命名空间中的API,业务系统中的其他命名空间的API将同时被导入。例如上图中导入命名空间 TEST-UP-s002中的API,则业务系统中其他命名空间如 TEST-UP-s003、TEST-UP-s004等中的API将被自动导入分组。

  3. 在【分组管理】页面,选择目标分组操作栏的【发布分组】。

  • 当且仅当分组被发布时,才能通过微服务网关访问微服务 API。
  • 如果某一个分组不想被访问,可以单击操作列的【下线分组】,将分组下线。

步骤四: 访问 API

分组下某个微服务 API 的访问路径为:网关的域名或网关的 IP+port/分组 context/微服务 API 所在的微服务业务系统名称/微服务名称/API 路径

举例:当分组 context 为 sell,微服务所在业务系统为 payment,微服务名称为 consumer,API 路径为/echo/{test}时,则访问路径为域名或网关 IP/sell/payment/consumer/echo/{test}
单击 API 路径后面的复制按钮,会自动复制从 context 以后的路径。
粘贴后的内容为/sell/payment/consumer/echo/{test}