上云无忧 > 文档中心 > 腾讯云 API 网关插件 - 概述
腾讯云 API 网关插件 - 概述

文档简介:
插件简介: 插件是 API 网关提供的高级功能配置,您可以通过插件创建 IP 访问控制、条件路由、断路器、防重放等能力项,再将插件绑定到 API 上生效。
*此产品及展示信息均由腾讯云官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠

插件简介

插件是 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 所绑定的插件信息。

插件规则

一个 API 只能绑定一个相同类型的插件。
插件具有地域属性,插件只能绑定到同一地域的 API,不支持跨地域绑定。
API 只有发布到相应环境后,才能和插件进行绑定,未发布的 API 不支持绑定。
将 API 下线不影响和插件的绑定关系,重新发布到环境后插件仍然会生效。
插件支持热更新,所有的绑定、解绑操作无需重新发布服务即可生效。
API 删除后,API 和插件的绑定关系也会一起删除。

已支持系统插件类型

IP访问控制
基础流量控制
参数流量控制
跨域访问控制
条件路由
缓存
防重放

已支持自定义插件类型

自定义认证
自定义请求体
自定义响应体

自定义插件的服务类型

在创建自定义插件时,需要先选择一种自定义服务类型,此类型表示该自定义插件的后端服务类型,满足如下规则:
当自定义服务类型选择云函数 SCF 时,可支持该插件绑定到 共享实例服务上的 API。
当自定义服务类型选择云函数 SCF公网内网 VPC 时,可支持该插件绑定到专享实例服务上的 API。
共享实例与专享实例的规格差异,请参见 实例规格

相似文档
  • 操作场景: IP 访问控制是 API 网关提供的安全防护能力,主要用于限制 API 的调用来源 IP,您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的 API 请求。
  • 操作场景: 基础流量控制插件是 API 网关提供的强大流控限制,支持API、应用、ClientIP 三个维度的限流和秒、分钟、小时、天的限流。您可创建基础流控插件并绑定到 API 生效,以保护您的后端服务。
  • 操作场景: 参数流控可以针对用户的请求参数以及用户在插件中设置的条件执行进行流控,参数流控配置支持如下特性: 支持秒、分钟、小时、天的流控维度。 可以根据客户端请求参数、API 网关内置的系统参数设置条件,来执行不同的流控维度。 可以使用单个参数、或多个参数的组合来设置流控。
  • 操作场景: 跨域资源共享(Cross-Origin Resource Sharing,CORS)是 W3C 的标准。CORS 允许 Web 应用服务器进行跨域访问控制,从而使跨域数据传输得以安全进行。目前 API 网关支持对 CORS 规则的配置,从而根据需求允许或者拒绝相应的跨域请求。
  • 操作场景: 条件路由插件可根据参数取值转发到不同后端。根据请求的参数取值与系统参数取值,按规则将不同的客户端请求转发到不同后端地址,可广泛应用于灰度发布、蓝绿发布、租户路由等场景。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部