目前插件仅在共享实例(VPC)与专享实例(VPC)可用, 共享实例(经典网络)目前暂不支持。

说明 在2019年发布的API网关新版本中,原有功能: 流量控制、IP访问控制、后端签名、JWT(OpenId Connect)的功能被统一到了插件体系中。新增功能: CORS(跨域资源访问),Caching(缓存),Routing(后端路由),参数访问控制,错误码映射,断路器等也可以通过插件来配置,未来会有越来越多的插件加入到API网关产品中来。

1. 插件使用规则

  • 一个API只能绑定一个相同类型的插件。
  • 插件仅与Region相关,可以绑定至本Region的API, 每个用户的插件限额为500个。
  • 插件策略和API分别是独立管理的,将插件绑定到API的指定环境后,插件策略才会对已绑定的API起作用。
  • 必须要发布API后才可将插件绑定至API对应发布的环境。
  • 插件的绑定、解绑、更新会实时生效,不需要重新发布API,对于风险比较高的API,请先在测试API上测试通过。
  • API的下线操作不影响插件的绑定关系,再次发布后仍然会带有下线前绑定的插件。
  • 如果插件上有已发布或者发布过但未删除的API, 则插件无法执行删除操作。

2. 支持插件列表

目前API网关支持下列6种插件,请点击链接查看:

3. 快速使用

  • 点击创建插件按钮创建插件。

  • 通过插件控制台将插件绑定至已发布的API当中。

  • 绑定后插件即可生效。

4. 开发者指南(OpenAPI)

插件管理相关的OPENAPI如下:

5. 使用限制

  • 单个插件元数据的大小限制为16380个字符。
  • 每个用户在每个Region创建插件的限制为1000个。
  • 控制台的调试功能暂时不支持JWT插件,建议使用Postman或者系统命令行 `curl` 调试。