Tencent Cloud

Recent Pages

插件概述

最后更新时间：2024-06-21 16:17:22

插件简介
插件是 API 网关提供的高级功能配置，您可以通过插件创建 IP 访问控制等配置项，再将插件绑定到 API 上生效。
相较于传统配置项，插件有以下优势：
功能配置与 API 配置解耦，一个插件可以绑定到多个不同服务下的不同 API 上。
支持配置热更新，将插件绑定到 API 上后，无需发布服务即可生效。
使用步骤
步骤1：创建插件
1. 登录 API 网关控制台。
2. 在左侧导航栏，单击插件，进入插件列表页。
3. 单击页面左上角的新建，新建一个插件。
﻿
﻿
﻿
步骤2：绑定 API 并生效
1. 在列表中选中刚刚创建好的插件，单击操作列的绑定 API。
2. 在绑定 API 弹窗中选择服务和环境，并选择需要绑定插件的 API。
﻿
﻿
﻿
3. 单击确定，即可将插件绑定到 API，此时插件的配置已经对 API 生效。
步骤3：查看 API 已绑定插件
1. 在左侧导航栏，单击服务，进入服务列表页。
2. 在服务列表中，单击目标服务的服务名，查看该服务。
3. 在 API 列表中，单击目标 API 的 API 名，查看该 API 详情页。
4. 在 API 详情页单击插件管理 tab 页，即可查看目标 API 所绑定的插件信息。
﻿
﻿
﻿
已支持插件类型
IP 访问控制。
说明：
API 网关目前仅支持 IP 访问控制插件，未来将加入流量控制、断路器、参数转换等更多插件。
插件规则
一个 API 只能绑定一个相同类型的插件。
插件具有地域属性，插件只能绑定到同一地域的 API，不支持跨地域绑定。
API 只有发布到相应环境后，才能和插件进行绑定，未发布的 API 不支持绑定。
将 API 下线不影响和插件的绑定关系，重新发布到环境后插件仍然会生效。
插件支持热更新，所有的绑定、解绑操作无需重新发布服务即可生效。
API 删除后，API 和插件的绑定关系也会一起删除。