新建API网关插件。
接口说明
- 此接口面向开放 API 的用户
- 限制每个用户同一类型的插件可以创建的数量,不同类型,上限不同
- 高级功能的插件定义限制使用
- 插件创建后未绑定 API 前是无意义的,绑定 API 后,对绑定的 API 即时生效。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:CreatePlugin | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PluginName | string | 是 | 插件名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。 | NewCors |
PluginType | string | 是 | 插件类型, 可选值:
| cors |
PluginData | string | 是 | 插件定义语句,支持 json、yaml | --- unit: SECOND apiDefault: 1000 userDefault: 30 appDefault: 30 specials: - type: "APP" policies: - key: 10123123 value: 10 - key: 10123123 value: 10 |
Description | string | 否 | 描述,限 200 字以内 | createPlugin |
Tag | array<object> | 否 | 指定规则所适用的对象标签,可设置多个。 | Key, Value |
object | 否 | |||
Key | string | 是 | 标签键。 n 的取值范围为 | env |
Value | string | 是 | 标签值。 n 的取值范围为 | ' ' |
返回参数
示例
正常返回示例
JSON
格式
{
"PluginId": "1f3bde29b43d4d53989248327ff737f2",
"TagStatus": true,
"RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史