查询插件绑定详情。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：GetPluginBinding

要执行的操作，取值：GetPluginBinding。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

Id string 可选示例值：pb-crb****

插件绑定关系 ID。您可以通过 ListPluginBindings 查询插件绑定关系 ID。

说明

Id和PluginName两个参数需至少配置一项，支持两项同时配置。

PluginName 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 黑白名单。

说明

Id和PluginName两个参数需至少配置一项，支持两项同时配置。

Scope string 可选示例值：ROUTE

绑定级别，取值：

ROUTE：路由级别。

SERVICE：服务级别。

GATEWAY：网关级别。

说明

当PluginName参数配置时，需要配置本参数。

Target string 可选示例值：rcrb****

绑定对象，路由 ID、服务 ID 或网关 ID。

说明

当PluginName参数配置时，需要配置本参数。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

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

路由名称。

说明

仅当绑定级别为路由级别时有返回值。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
404	ResourceNotFound	The specified resource %s %s cannot be found.	指定资源找不到。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。