创建插件

最近更新时间:2024-03-12 01:08:38

我的收藏

1. 接口描述

接口请求域名: apigateway.tencentcloudapi.com 。

创建API网关插件。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePlugin。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
PluginName String 用户自定义的插件名称。最长50个字符,最短2个字符,支持 a-z,A-Z,0-9,_, 必须字母开头,字母或者数字结尾。
示例值:myplugin
PluginType String 插件类型。目前支持IPControl, TrafficControl, Cors, CustomReq, CustomAuth,Routing,TrafficControlByParameter, CircuitBreaker, ProxyCache。
示例值:IPControl
PluginData String 插件定义语句,支持json。
Description String 插件描述,限定200字以内。
示例值:myPlugin
Tags.N Array of Tag 标签

3. 输出参数

参数名称 类型 描述
Result Plugin 新建的插件详情。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreatePlugin

输入示例

https://apigateway.tencentcloudapi.com/?Action=CreatePlugin
&PluginName=mytestPlugin
&PluginType=IPControl
&Description=IPControl
&PluginData={"blocks":"1.1.1.12","type":"black_list"}
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "PluginId": "plugin-qrboebt1",
            "PluginName": "mytestPlugin",
            "PluginType": "IPControl",
            "Description": "IPControl",
            "PluginData": "{\"blocks\":\"1.1.1.12\",\"type\":\"black_list\"}",
            "CreatedTime": "2021-01-25T05:46:25Z",
            "ModifiedTime": "2021-01-25T05:46:25Z",
            "AttachedApiTotalCount": null,
            "AttachedApis": null
        },
        "RequestId": "b4ffe46b-ae2c-4ff1-911b-57fe15f3d95b"
    }
}

示例2 创建缓存插件

输入示例

https://apigateway.tencentcloudapi.com/?Action=CreatePlugin
&PluginName=myCachePlugin
&PluginType=ProxyCache
&Description=myCachePlugin
&PluginData={"cache_key_params":[{"parameter":"param1","position":"header"},{"parameter":"param2","position":"query"},{"parameter":"param3","position":"path"}],"cacheable_methods":["GET","POST"],"cacheable_response_codes":[200,301,404],"cache_control":false,"ttl":300}
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "PluginId": "plugin-pbboebt1",
            "PluginName": "myCachePlugin",
            "PluginType": "ProxyCache",
            "Description": "myCachePlugin",
            "PluginData": "{\"cache_key_params\":[{\"parameter\":\"param1\",\"position\":\"header\"},{\"parameter\":\"param2\",\"position\":\"query\"},{\"parameter\":\"param3\",\"position\":\"path\"}],\"cacheable_methods\":[\"GET\",\"POST\"],\"cacheable_response_codes\":[200,301,404],\"cache_control\":false,\"ttl\":300}",
            "CreatedTime": "2021-01-25T05:46:25Z",
            "ModifiedTime": "2021-01-25T05:46:25Z",
            "AttachedApiTotalCount": null,
            "AttachedApis": null
        },
        "RequestId": "b4ffe46b-ae2c-4ff1-911b-57fe15f3d95a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ServiceInOperation 当前Service正在操作中, 请稍后再试。
FailedOperation.TagBindServiceError 标签绑定服务失败。
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.TsfException TSF内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.VpcException vpc内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.DuplicatePluginConfig 插件定义参数取值重复,请修改后重新操作。
InvalidParameterValue.InvalidApiRequestConfig 无效的API配置。
InvalidParameterValue.InvalidBackendPath 后端服务路径配置错误。
InvalidParameterValue.InvalidClb 不合法的clb。
InvalidParameterValue.InvalidCondition 策略错误。
InvalidParameterValue.InvalidIPAddress 参数后端地址取值错误。
InvalidParameterValue.InvalidPluginConfig 插件定义参数取值错误,请修改后重新操作。
InvalidParameterValue.InvalidPort 后端服务端口错误。
InvalidParameterValue.InvalidScfConfig SCF类型API参数错误。
InvalidParameterValue.InvalidServiceConfig 不合法的服务配置。
InvalidParameterValue.InvalidServiceParam 参数配置错误,未配置在后端参数配置列表中。
InvalidParameterValue.InvalidServiceType 后端服务类型错误。WEBSOCKET类型的后端服务,前端协议需要配置为WEBSOCKET。
InvalidParameterValue.InvalidUpstream 当前后端通道不存在或者是无效状态。
InvalidParameterValue.InvalidUrl URL参数错误。
InvalidParameterValue.InvalidVpcConfig 无效vpc信息。
InvalidParameterValue.LengthExceeded 参数的长度超出限制。
InvalidParameterValue.NotInOptions 参数取值错误。当前值不在可选范围内。
InvalidParameterValue.ParameterValueLimitExceeded 参数个数超过限制。
InvalidParameterValue.RangeExceeded 参数取值错误,不在参数范围内。
MissingParameter.BackendSpecificParam 缺少后端服务参数。
MissingParameter.PluginConfig 插件缺少参数,请按规则重新操作。
UnauthorizedOperation.UncertifiedUser 用户未实名制。
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.UnpackError Unpack函数错误