查询插件绑定详情
更新时间:2026-09-20
该接口用于查询当前账号下指定插件绑定的详情,包括插件定义、绑定配置、绑定状态、生效级别,以及关联的网关实例、服务或 API 信息(以绑定记录实际关联为准)。
请求结构
Plain Text
1POST /?action=DescribePluginBinding HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "pluginBindingId": pluginBindingId
7}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pluginBindingId | String | 是 | RequestBody参数 | 插件绑定 ID |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pluginBindingId | String | 插件绑定 ID |
| pluginId | String | 插件 ID |
| pluginName | String | 插件名称 |
| pluginImage | String | 插件镜像 |
| version | String | 插件版本 |
| pluginConfig | String | 插件配置 |
| pluginType | String | 插件类型 |
| effectiveLevel | String | 生效级别 |
| instanceId | String | 网关实例 ID |
| instanceName | String | 网关实例名称 |
| serviceId | String | 服务 ID |
| serviceName | String | 服务名称 |
| apiId | String | 路由 ID |
| apiName | String | 路由名称 |
| status | String | 状态 |
| description | String | 描述 |
| executionPriority | int | 执行优先级 |
| pluginPhase | String | 插件阶段 |
| versionDescription | String | 版本描述 |
| pluginCategory | String | 用户可见插件能力分类 |
| pluginSource | String | 插件来源:GATEWAY / CUSTOM |
| effectiveExecutionPriority | int | 偏移后的真实执行优先级 |
| effectiveScope | String | 路由类型生效范围 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: pluginBindingId must not be blank | 400 | 必填参数缺失或格式不合法,pluginBindingId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON,无法解析,请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源,请确认使用正确的账号凭证且资源属于当前账号 |
| PluginReleaseBindNotExist | Plugin release bind not exist. | 404 | 插件绑定不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持,请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribePluginBinding HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "pluginBindingId": "plugin_bind-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 "pluginBindingId": "plugin_bind-a1b2c3d4",
9 "pluginId": "pls-a1b2c3d4",
10 "pluginName": "限流插件",
11 "pluginImage": "rate-limit",
12 "version": "1.0.0",
13 "pluginConfig": "{}",
14 "pluginType": "system_wasm",
15 "effectiveLevel": "Instance",
16 "instanceId": "gw-a1b2c3d4",
17 "instanceName": "生产网关",
18 "status": "Enabled",
19 "description": "按 QPS 限流",
20 "executionPriority": 10,
21 "pluginPhase": "AUTHZ",
22 "versionDescription": "初始版本",
23 "pluginCategory": "流量管控",
24 "pluginSource": "GATEWAY",
25 "effectiveExecutionPriority": 10,
26 "effectiveScope": "HTTP_ROUTE"
27}
评价此篇文章
