安装插件到API
更新时间：2026-09-22
该接口用于将指定插件批量安装到 API，并同步相关网关实例的数据面插件配置。新建 API 级绑定时，逻辑路由的绑定统一记录在入口路由，并在运行时投影到该逻辑路由下已发布的子路由。
注意事项：
- 同一插件不能在同一逻辑 API 重复创建绑定；传入子路由 ID 时会归一到对应入口路由。
- 自定义 ExtProc 只能安装到其所属实例下的 API；其 API 级
pluginConfig必须符合路由级配置结构。
请求结构
Plain Text
1POST /?action=InstallPluginToApis HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "pluginId": pluginId,
7 "apiIds" : [apiId],
8 "pluginConfig": pluginConfig,
9 "status": status
10}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pluginId | String | 是 | RequestBody参数 | 插件 Release ID |
| apiIds | List<String> | 是 | RequestBody参数 | 路由 ID 列表 |
| pluginConfig | String | 否 | RequestBody参数 | 插件配置 |
| status | String | 是 | RequestBody参数 | 启用状态：Enabled / Disabled |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pluginBindingIds | List<String> | 插件绑定 ID 列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: pluginId must not be blank | 400 | 必填参数缺失或格式不合法，pluginId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源，请确认使用正确的账号凭证且资源属于当前账号 |
| PluginReleaseNotExist | Plugin release not exist. | 404 | 插件 Release 不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
| DataPlaneSyncFailed | 配置已保存成功，但网关操作失败，请稍后重试或联系技术支持。 | 500 | 配置已写入控制面，但下发数据面失败，请稍后重试或联系技术支持 |
请求示例
Plain Text
1POST /?action=InstallPluginToApis HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "pluginId": "pls-a1b2c3d4",
7 "apiIds": [
8 "api-a1b2c3d4"
9 ],
10 "pluginConfig": "{}",
11 "status": "Enabled"
12}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "pluginBindingIds": [
9 "plugin_bind-a1b2c3d4"
10 ]
11}评价此篇文章