查询插件详情
更新时间：2026-09-20
该接口用于按插件 ID 查询插件定义详情，包括名称、版本、说明文档、默认配置、实现类型、执行阶段和执行优先级等信息。自定义插件仅允许其所属账号查询。
请求结构
Plain Text
1POST /?action=DescribePlugin HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "pluginId": pluginId
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pluginId | String | 是 | RequestBody参数 | 插件 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pluginId | String | 插件 ID |
| name | String | 插件名称 |
| description | String | 插件描述 |
| type | String | 插件类型：FlowControl-流量管控，Auth-认证鉴权 |
| version | String | 插件版本 |
| document | String | 说明文档 |
| defaultConfig | String | 默认配置 |
| executionPriority | int | 执行优先级 |
| pluginPhase | String | 插件阶段 |
| versionDescription | String | 版本描述 |
| pluginType | String | 插件实现类型：system_wasm / system_extproc / system_envoyfilter_wasm / custom_wasm / custom_extproc |
| pluginSource | String | 插件来源：GATEWAY / CUSTOM |
| effectiveExecutionPriority | int | 偏移后的真实执行优先级 |
错误码
| 错误码 | 错误描述 | 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 |
请求示例
Plain Text
1POST /?action=DescribePlugin HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "pluginId": "pls-a1b2c3d4"
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 "pluginId": "pls-a1b2c3d4",
9 "name": "限流插件",
10 "description": "按 QPS 限流",
11 "type": "FlowControl",
12 "version": "1.0.0",
13 "document": "https://example.com/rate-limit.md",
14 "defaultConfig": "{}",
15 "executionPriority": 10,
16 "pluginPhase": "AUTHZ",
17 "versionDescription": "初始版本",
18 "pluginType": "system_wasm",
19 "pluginSource": "GATEWAY",
20 "effectiveExecutionPriority": 10
21}评价此篇文章