首页 API 网关 开发指南 API参考指南 API目录 插件 CreatePlugin - 创建API网关插件

CreatePlugin - 创建API网关插件

新建API网关插件。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:CreatePluginWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*/*

请求参数

名称类型必填描述示例值
PluginNamestring

插件名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。

NewCors
PluginTypestring

插件类型, 可选值:

  • ipControl:IP访问控制
  • trafficControl:流量控制
  • backendSignature:后端签名
  • jwtAuth:JWT(OpenId Connect)
  • cors:CORS跨域资源访问
  • caching:缓存
  • basicAuth: Basic Auth
  • routing:后端路由
  • accessControl:参数访问控制
  • errorMapping:错误码映射
  • circuitBreaker:断路器(仅专享实例)
  • remoteAuth:第三方鉴权(仅专享实例)
cors
PluginDatastring

插件定义语句,支持json、yaml

--- unit: SECOND apiDefault: 1000 userDefault: 30 appDefault: 30 specials: - type: "APP" policies: - key: 10123123 value: 10 - key: 10123123 value: 10
Descriptionstring

描述,限200字以内

createPlugin
Tagarray

指定规则所适用的对象标签,可设置多个。

object
Keystring

标签键。

n 的取值范围为 [1, 20]

env
Valuestring

标签值。

n 的取值范围为 [1, 20]

' '

返回参数

名称类型描述示例值
object
PluginIdstring

生成的插件ID

1f3bde29b43d4d53989248327ff737f2
TagStatusboolean

是否成功标记插件

true
RequestIdstring

请求ID

EF924FE4-2EDD-4CD3-89EC-34E4708574E7

错误码

访问错误中心查看更多错误码。

阿里云首页 API 网关 相关技术圈