AttachPlugin
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名: apigateway.api3.fincloud.tencent.cn。
绑定插件到API上。
默认接口请求频率限制:20次/秒。
接口更新时间:2021-10-22 14:54:32。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:AttachPlugin |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-08-08 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| PluginId | 是 | 否 | String | 绑定的API网关插件ID。 |
| ServiceId | 是 | 否 | String | 要操作的服务ID。 |
| EnvironmentName | 是 | 否 | String | 要操作API的环境。 |
| ApiIds | 是 | 否 | Array of String | 要绑定的API列表。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 绑定操作是否成功。 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.InvalidApi | ApiId错误。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| InternalError.OssException | oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。 |
| InvalidParameterValue.InvalidEnvStatus | 服务当前环境状态,不支持此操作。 |
| InvalidParameterValue.LimitExceeded | 参数个数超出限制,上限为100。 |
| ResourceNotFound.InvalidPlugin | 插件不存在。 |
| LimitExceeded.ServiceCountForPluginLimitExceeded | 插件绑定的服务数量超出限制,请解绑服务或提升限额后重试。 |
| UnauthorizedOperation.AccessResource | 您没有权限访问资源。 |
| FailedOperation.ServiceInOperation | 当前Service正在操作中, 请稍后再试。 |
| UnsupportedOperation.AttachPlugin | 当前插件不支持绑定。 |