创建插件
最近更新时间: 2024-10-18 10:38:32
1. 接口描述
接口请求域名: apigateway.api3.fincloud.tencent.cn。
创建API网关插件。
默认接口请求频率限制:20次/秒。
接口更新时间:2021-10-25 19:58:32。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:CreatePlugin |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-08-08 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
PluginName | 是 | 否 | String | 用户自定义的插件名称。最长50个字符,最短2个字符,支持 a-z,A-Z,0-9,_, 必须字母开头,字母或者数字结尾。 |
PluginType | 是 | 否 | String | 插件类型。目前支持IPControl, TrafficControl, Cors, CustomReq, CustomAuth。 |
Description | 否 | 否 | String | 插件描述,限定200字以内。 |
PluginData | 是 | 否 | String | 插件定义语句,支持json。 |
PluginAttribute | 否 | 否 | String | 此参数对外不可见。 参数属性,System:系统插件,Custom:自定义插件,默认为System。 |
Tags | 否 | 否 | Array of Tag | 此参数对外不可见。 标签 |
ProjectId | 否 | 否 | String | 项目id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Plugin | 新建的插件详情。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.FormatError | |
InternalError.OssException | |
InvalidParameterValue.RangeExceeded | |
InvalidParameterValue.NotInOptions | |
UnsupportedOperation.InvalidAction | |
FailedOperation.ServiceInOperation | |
InvalidParameterValue.InvalidCondition | |
InvalidParameterValue.InvalidPluginConfig | |
InvalidParameterValue.DuplicatePluginConfig |