概述
路由级插件可绑定在某一特定路由上,允许根据具体的路由定制化功能。
路由级插件使用规则:
- 路由级插件支持绑定到路由、分组和API三种场景中。
- 一个路由/分组/API只能绑定一个相同类型的插件。再次绑定同类型的插件时会覆盖原有的插件配置。
- 插件的绑定、解绑、更新会实时生效,不需要重新发布路由。
- 路由上可启用相同类型的路由策略和路由级插件,以最新的插件配置生效。
- 路由的上下线不会影响路由级插件的绑定关系。
- 插件绑定到分组/API的指定环境后,插件策略会自动对该环境下已发布的API起作用。
- 如果API和分组使用了绑定了相同类型的插件,那么API绑定的插件具有更高的优先级。
- 果插件已被路由/分组/API所绑定,则该插件不可被删除。
查看路由级插件列表
操作步骤
- 进入微服务引擎MSE控制台;
- 在顶部菜单栏选择资源池;
- 单击左侧导航栏云原生网关 > 网关列表 ;
- 您可以在网关列表页单击需要查看的网关实例ID或者 实例名称 ,也可以单击操作列中的管理按钮;
- 单击左侧导航栏 路由级插件 ,展示了目前已创建的路由级插件列表;
创建路由级插件
操作步骤
- 点击创建插件按钮,进入插件创建页面;
- 基础信息填写 插件名称 ,下拉选择 插件类型 ,选填描述信息;
- 脚本配置下拉选择配置模板后,配置窗口中显示该插件类型的配置模板信息,您可以根据需要对该插件配置进行修改编辑;
- 点击提交按钮,会对该插件配置参数进行校验,校验通过后则成功创建路由级插件;
填写参数说明如下:
配置项 | 说明 |
---|---|
插件名称 | 用于标志唯一插件,不可重复。 |
插件类型 | 从给定插件类型下拉列表中选择。 |
描述 | 插件配置的描述信息,可不填。 |
选择配置模板 | 部分插件类型包括基础配置案例,经典配置案例两种模板。 |
配置窗口 | 选择模板后会自动出现插件配置原始模板,用户可根据需求场景灵活定义配置参数值。 |
删除路由级插件
操作步骤
- 进入路由级插件配置列表页,点击操作栏中的删除按钮即可;
绑定路由级插件
API绑定插件
操作步骤-绑定途径1
- 进入路由级插件配置列表页,点击操作栏中的绑定按钮,下拉选择API;
- 在弹框中展示了网关实例上所有的API,绑定API时必须选定分组与环境。点击每条API的添加按钮,或是选中多条API后点击添加选中按钮,右侧已选择API框中展示了已添加的API;
- 点击已选择API中的移除按钮,可取消该API的选择;
- 支持对API进行分页展示,以及API名称和请求路径的模糊搜索;
- 点击确认按钮,插件配置绑定API成功;
操作步骤-绑定途径2
- 进入API托管->API列表菜单页 ;
- 点击API 名称 ,进入API详情页;
- 进入已绑插件页,展示了该API已经绑定的路由级插件配置列表;
- 点击绑定插件按钮,弹框中展示了所有的路由级插件配置列表,点击每个插件配置的添加按钮,或是选中多个插件配置后点击添加选中按钮,右侧已选择插件框中展示了已添加的路由级插件配置;
- 点击已选择插件中的移除按钮,可取消该插件配置的选择;
- 支持对插件配置进行分页展示,以及插件名称和插件类型的模糊搜索;
- 点击确认按钮,插件配置绑定路由成功;
分组绑定插件
操作步骤-绑定途径1
- 进入路由级插件配置列表页,点击操作栏中的绑定按钮,下拉选择分组;
- 在弹框中展示了网关实例上所有的分组,绑定分组时必须选定环境。点击每条分组的添加按钮,或是选中多条分组后点击添加选中按钮,右侧已选择分组框中展示了已添加的分组;
- 点击已选择分组中的移除按钮,可取消该分组的选择;
- 支持对分组进行分页展示,以及分组名称的模糊搜索;
- 点击确认按钮,插件配置绑定分组成功;
操作步骤-绑定途径2
- 进入API托管->API分组菜单页;
- 点击插件管理 ,进入已绑插件页,展示了该分组在不同环境下已经绑定的路由级插件配置列表;
- 点击绑定插件按钮,弹框中展示了所有的路由级插件配置列表,点击每个插件配置的添加按钮,或是选中多个插件配置后点击添加选中按钮,右侧已选择插件框中展示了已添加的路由级插件配置;
- 点击已选择插件中的移除按钮,可取消该插件配置的选择;
- 支持对插件配置进行分页展示,以及插件名称和插件类型的模糊搜索;
- 点击确认按钮,插件配置绑定路由成功;
路由绑定插件
操作步骤-绑定途径1
- 进入路由级插件配置列表页,点击操作栏中的绑定按钮,下拉选择路由;
- 在弹框中展示了网关实例上所有的路由,点击每条路由的添加按钮,或是选中多条路由后点击添加选中按钮,右侧已选择路由框中展示了已添加的路由;
- 点击已选择路由中的移除按钮,可取消该路由的选择;
- 支持对路由进行分页展示,以及路由名称和请求路径的模糊搜索;
- 点击确认按钮,插件配置绑定路由成功。
操作步骤-绑定途径2
-
进入路由配置菜单页;
-
点击路由名称或查看按钮,进入路由详情页;
-
进入已绑插件页,展示了该路由已经绑定的路由级插件配置列表;
-
点击绑定插件按钮,弹框中展示了所有的路由级插件配置列表,点击每个插件配置的添加按钮,或是选中多个插件配置后点击添加选中按钮,右侧已选择插件框中展示了已添加的路由级插件配置;
-
点击已选择插件中的移除按钮,可取消该插件配置的选择;
-
支持对插件配置进行分页展示,以及插件名称和插件类型的模糊搜索;
-
点击确认按钮,插件配置绑定路由成功;
解绑路由级插件
API解绑插件
操作步骤-解绑途径1
- 进入路由级插件配置列表页,点击操作栏中的解绑按钮,下拉选择API;
- 弹框中展示了当前该插件配置已绑定的API列表;
- 选择要解绑的环境,点击每个API列表的添加按钮,或是选中多个API后点击添加选中按钮,右侧已选择API框中展示了已添加的API列表;
- 点击已选择API中的移除按钮,可取消该API的选择;
- 点击确认按钮,插件配置与API解绑成功;
操作步骤-解绑途径2
- 进入API 托管->API列表菜单页;
- 点击API名称 ,进入API详情页;
- 进入已绑插件页,展示了该API已经绑定的路由级插件配置列表;
- 选中多个插件配置后点击批量解除绑定按钮;
- 在弹框中点击确认按钮,插件配置与API解绑成功;
分组解绑插件
操作步骤-解绑途径1
- 进入路由级插件配置列表页,点击操作栏中的解绑按钮,下拉选择分组;
- 弹框中展示了当前该插件配置已绑定的分组列表;
- 选择要解绑的环境,点击每个分组列表的添加按钮,或是选中多个分组后点击添加选中按钮,右侧已选择分组框中展示了已添加的分组列表;
- 点击已选择分组中的移除按钮,可取消该分组的选择;
- 点击确认按钮,插件配置与分组解绑成功;
操作步骤-解绑途径2
- 进入 API托管-> 分组列表菜单页;
- 点击插件管理 ,进入已绑插件页,展示了该分组已经绑定的路由级插件配置列表;
- 点击单个已绑分组中的解绑按钮,或是选中多个插件配置后点击批量解除绑定按钮;
- 在弹框中点击确认按钮,插件配置与分组解绑成功;
路由解绑插件
操作步骤-解绑途径1
- 进入路由级插件配置列表页,点击操作栏中的解绑按钮,下拉选择路由;
- 弹框中展示了当前该插件配置已绑定的路由列表;
- 点击每个路由列表的添加按钮,或是选中多个路由后点击添加选中按钮,右侧已选择路由框中展示了已添加的路由列表;
- 点击已选择路由中的移除按钮,可取消该路由的选择;
- 点击确认按钮,插件配置与路由解绑成功;
操作步骤-解绑途径2
- 进入路由配置菜单页;
- 点击路由名称或查看按钮,进入路由详情页;
- 进入已绑插件页,展示了该API已经绑定的路由级插件配置列表;
- 点击每个插件配置的解除按钮,或是选中多个插件配置后点击批量解除绑定按钮;
- 支持对插件配置进行分页展示,以及插件名称和插件类型的模糊搜索;
- 在弹框中点击确认按钮,插件配置与路由解绑成功;