查询插件列表
更新时间:2026-09-20
该接口用于查询当前可见的插件列表,并支持按插件名称进行模糊筛选。结果排除自定义 ExtProc 插件,返回插件标识、名称、版本、来源、分类和执行优先级等信息。
请求结构
Plain Text
1POST /?action=DescribePlugins HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": name
7}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | 否 | RequestBody参数 | 插件名称 |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pluginId | String | 插件 ID |
| pluginImage | String | 插件标识 |
| name | String | 插件名称 |
| description | String | 插件描述 |
| type | String | 插件类型:FlowControl-流量管控,Auth-认证鉴权 |
| version | String | 插件版本 |
| pluginSource | String | 插件来源:GATEWAY / CUSTOM |
| executionPriority | int | 数据库保存的用户优先级 |
| effectiveExecutionPriority | int | 偏移后的真实执行优先级 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON,无法解析,请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源,请确认使用正确的账号凭证且资源属于当前账号 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持,请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribePlugins HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "name": "限流"
7}
返回示例
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 {
9 "pluginId": "pls-a1b2c3d4",
10 "pluginImage": "rate-limit",
11 "name": "限流插件",
12 "description": "按 QPS 限流",
13 "type": "FlowControl",
14 "version": "1.0.0",
15 "pluginSource": "GATEWAY",
16 "executionPriority": 10,
17 "effectiveExecutionPriority": 10
18 }
19]
评价此篇文章
