文档中心

API 网关

插件管理

ListPluginBindings - 批量查询插件绑定关系

批量查询插件绑定关系。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListPluginBindings&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListPluginBindings	接口名称。当前 API 的名称为 ListPluginBindings。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	分页查询的页号。取值最小限制为 1，默认值为 1。
PageSize	Long	否	10	每页个数。取值范围为 0~100，默认值为 0。
Filter	Object of PluginBindingFilter	否	-	过滤条件。

PluginBindingFilter

参数	类型	是否必选	示例值	描述
Scope	String	否	ROUTE	绑定级别，取值： ROUTE：路由级别。 SERVICE：服务级别。 GATEWAY：网关级别。
Name	String	否	wasm-key-auth	插件名称，取值： hmac-auth：HMAC 认证。 wasm-key-auth：API Key 认证。 wasm-ext-auth：外部认证。 wasm-oauth2-sso：OAuth2 单点登录。 local-rate-limit：限流。 native-load-aware：LLM 负载感知路由。 native-stateful-session：LLM session 亲和路由。 lua-mcp-stateful-session：MCP 会话保持。 cluster-rate-limit：全局限流。 content-digest：LLM 会话保持 ID 生成。 geoip：GeoIP 地理定位。 ip-restriction：IP 黑白名单。
Enable	Boolean	否	true	插件是否开启。取值： true：开启。 false：不开启。
GatewayId	String	否	gd8****	网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。

请求示例

返回参数

PluginBinding

参数	类型	示例值	描述
Id	String	pb-crb****	插件绑定关系 ID。
PluginName	String	local-rate-limit	插件名称。
Scope	String	ROUTE	绑定级别。取值： ROUTE：路由级别。 SERVICE：服务级别。 GATEWAY：网关级别。
Target	String	rcrb****	绑定对象，路由 ID、服务 ID 或网关 ID。
Enable	Boolean	true	插件是否开启。取值： true：开启。 false：不开启。
PluginConfig	String	-	插件配置。
Description	String	example	插件备注详情。
TargetName	String	example	绑定对象名称，路由名称、服务名称或网关名称。
UpdateTime	String	2025-01-01T00:00:00+08:00	插件绑定关系更新时间。标准 RFC3339 格式的 UTC+8 时间。
GatewayId	String	gd8****	网关实例 ID。
GatewayName	String	example	网关名称。
ServiceId	String	sd84****	服务 ID。说明仅当绑定级别为服务级别或路由级别时有返回值。
ServiceName	String	example	服务名称。说明仅当绑定级别为服务级别或路由级别时有返回值。
RouteId	String	rcrb****	路由 ID。说明仅当绑定级别为路由级别时有返回值。
RouteName	String	example	路由名称。说明仅当绑定级别为路由级别时有返回值。

返回示例

错误码

本接口无特有的错误码。更多信息请参见公共错误码。

最近更新时间：2026.07.29 10:20:05

这个页面对您有帮助吗？

有用

无用