插件绑定API

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

我的收藏

1. 接口描述

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

绑定插件到API上。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AttachPlugin。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
PluginId String 绑定的API网关插件ID。
示例值:plugin-2nuhovb7
ServiceId String 要操作的服务ID。
示例值:service-jzo37opy
EnvironmentName String 要操作API的环境。
示例值:release
ApiIds.N Array of String 要绑定的API列表。
示例值:['api-buz84890','api-9nb6hd46']

3. 输出参数

参数名称 类型 描述
Result Boolean 绑定操作是否成功。
示例值:true
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 AttachPlugin

连接插件

输入示例

https://apigateway.tencentcloudapi.com/?Action=AttachPlugin
&ServiceId=Service-3fasdgrg
&PluginId=Plugin-3datbg1f
&EnvironmentName=release
&ApiIds.0=api-gesv1rfa
&ApiIds.1=api-9ads3g
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": true,
        "RequestId": "bb85842c-c0d2-4543-8f4d-396a193babe8"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InvalidInputJSON 无效的输入json
FailedOperation.ServiceError 服务相关的错误。
FailedOperation.ServiceInOperation 当前Service正在操作中, 请稍后再试。
FailedOperation.TaskAlreadyExist 迁移任务重复
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.ReturnableException 标签回调失败。
InvalidParameter.DuplicatePluginConfig 当前绑定插件和已有插件冲突。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.DuplicatePluginConfig 插件定义参数取值重复,请修改后重新操作。
InvalidParameterValue.InvalidEnvStatus 服务当前环境状态,不支持此操作。
InvalidParameterValue.InvalidServiceConfig 不合法的服务配置。
InvalidParameterValue.LimitExceeded 参数个数超出限制,上限为100。
InvalidParameterValue.TrafficControl 无效的参数值
LimitExceeded.ServiceCountForPluginLimitExceeded 插件绑定的服务数量超出限制,请解绑服务或提升限额后重试。
ResourceNotFound.InvalidApi ApiId错误。
ResourceNotFound.InvalidPlugin 插件不存在。
ResourceNotFound.InvalidService 对应服务不可见。
UnauthorizedOperation.AccessResource 您没有权限访问资源。
UnsupportedOperation.AttachPlugin 当前插件不支持绑定。
UnsupportedOperation.BasicServiceNotAllowAttachPlugin 基础服务不允许连接插件
UnsupportedOperation.InvalidEndpointType 不支持后端类型。
UnsupportedOperation.UnpackError Unpack函数错误