文档中心

API 网关

插件管理

CreatePluginBinding - 创建插件绑定关系

创建插件绑定路由、服务或网关实例。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：CreatePluginBinding

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

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

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

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

Scope string 必选示例值：ROUTE

绑定级别，取值：

ROUTE：路由级别。

SERVICE：服务级别。

GATEWAY：网关级别。

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

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

Enable boolean 必选示例值：true

插件是否开启。取值：

true：开启。

false：不开启。

PluginConfig string 必选示例值：-

插件配置。支持 JSON 字符串。

Description string 可选示例值：example

插件备注详情。长度限制为 0~253 个字符。

返回参数

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

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

插件绑定关系 ID。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
403	OperationDenied	Operation is denied because %s.	操作不合法。请修改后重试。
409	DuplicatedResource	Resource %s %s already exists.	资源已重复。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.10.28 14:59:50

这个页面对您有帮助吗？

有用

无用