You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
插件管理
CreatePluginBinding - 创建插件绑定关系
复制全文
下载 pdf
CreatePluginBinding - 创建插件绑定关系
创建插件绑定路由、服务或网关实例。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=CreatePluginBinding&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
CreatePluginBinding​
接口名称。当前 API 的名称为 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 个字符。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=CreatePluginBinding&Version=2021-03-03​
Content-Type: application/json​
{​
"PluginName": "wasm-key-auth",​
"Scope": "ROUTE",​
"Target": "rcrb****",​
"Enable": true,​
"PluginConfig": "-",​
"Description": "example"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Id​
String​
pb-crb****​
插件绑定关系 ID。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "CreatePluginBinding",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "pb-crb****"​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:05
这个页面对您有帮助吗?
有用
有用
无用
无用