全部产品

创建插件

更新时间:2019-01-21 14:27:05

描述

新建API网关插件

  • 此接口面向开放API的用户
  • 限制每个用户同一类型的插件可以创建的数量,不同类型,上限不同
  • 高级功能的插件定义限制使用
  • 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:CreatePlugin
PluginName String 插件名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。
PluginType String 插件类型, 可选值:
  • ipControl : IP访问控制
  • trafficControl : 流量控制
  • backendSignature : 后端签名
  • jwtAuth : JWT(OpenId Connect)
  • cors : CORS跨域资源访问
  • caching : 缓存
PluginData String 插件定义语句,支持json、yaml
Description String 描述,限200字以内

返回参数

名称 类型 描述
RequestId String 本次请求编号
PluginId String 生成的插件id

示例

请求示例

  1. http://apigateway.cn-qingdao.aliyuncs.com/?Action=CreatePlugin
  2. &PluginName=NewCors
  3. &PluginType=cors
  4. &PluginData="Plugin definition"
  5. &Description="createPlugin"
  6. &<公共请求参数>

返回示例

XML格式

  1. <CreatePluginResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
  3. <PluginId>285bb759342649a1b70c2093a772e087</PluginId>
  4. </CreatePluginResponse>

JSON格式

  1. {
  2. "RequestId":"EF924FE4-2EDD-4CD3-89EC-34E4708574E7",
  3. "PluginId" :"1f3bde29b43d4d53989248327ff737f2"
  4. }