文档中心

AI 原生 BaaS 平台 Supabase 版

SQL 限流

CreateSQLConcurrencyControlRule

CreateSQLConcurrencyControlRule

调用 CreateSQLConcurrencyControlRule 接口创建 SQL 限流规则。

请求类型

同步请求。

注意事项

该接口仅能用于操作使用 PostgreSQL 引擎的 Workspace（工作区）。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
WorkspaceId	String	是	noble-heath-3a48****	Workspace 的 ID。
BranchId	String	是	br-merry-scup-42d3****	分支 ID。
DatabaseName	String	是	test-db	数据库的名称。
Match	Object of RuleMatch	是	{"Type":"query_string","QueryString":"SELECT * FROM orders"}	限流规则匹配条件。支持按 SQL 文本、关键字或全部 SQL 匹配。
LimitConfig	Object of RuleConfig	是	{"Type":"concurrency","MaxConcurrency":10,"MaxWaiting":20,"MaxWaitMs":1000}	限流配置。支持并发数限流和 QPS 限流。
OverLimitAction	String	是	reject	限流规则超限时的处置方式。取值： reject：拒绝请求。仅 QPS 限流支持。 queue：排队等待。仅并发限流支持。
NodeType	String	是	All	规则生效的节点范围。取值： Primary：主节点。 Standby：备节点。 All：全部节点。
Enabled	Boolean	否	true	是否在创建规则后启用。取值： true：是。默认值。 false：否。
Comment	String	否	限制慢查询并发	限流规则的注释。最大长度为 256 个字符。
SearchPath	String	否	public	限流规则为按 SQL 文本匹配时，计算 SQL 文本对应的 queryId 时使用的 search_path，最大长度为 256 个字符。
EffectType	String	否	NextWakeUp	生效方式。取值： Immediate：如 Workspace 处于运行中，立即生效；如 Workspace 处于休眠中，则在唤醒时生效。默认值。 NextWakeUp：下次唤醒时生效。
CreateMode	String	否	Overwrite	SQL 限流规则的创建模式。取值： ErrorIfExists：已存在则报错。默认值。 Overwrite：覆盖已存在的规则。

RuleMatch

参数	类型	是否必选	示例值	描述
Type	String	是	query_string	匹配类型。取值： query_string：按 SQL 文本匹配。 keywords：按关键字匹配。 all：匹配全部 SQL。
Keywords	Array of String	否	["slow_query"]	关键字。当 Type 取值为 keywords 时使用。
QueryString	String	否	SELECT * FROM orders	SQL 文本。当 Type 取值为 query_string 时使用。

RuleConfig

参数	类型	是否必选	示例值	描述
Type	String	是	concurrency	限流类型。取值： concurrency：并发数限流。 qps：QPS 限流。
QPS	Integer	否	100	每秒允许通过的请求数。当 Type 为 qps 时使用。
Burst	Integer	否	200	Token Bucket 桶容量。当 Type 为 qps 时使用。
MaxWaitMs	Integer	否	1000	最大等待时间，单位为毫秒。0 表示不限制等待时间。当 Type 为 concurrency 时使用。
MaxWaiting	Integer	否	20	最大等待排队数。当 Type 为 concurrency 时使用。
MaxConcurrency	Integer	否	10	最大并发数。当 Type 为 concurrency 时使用。

返回参数

参数	类型	示例值	描述
Code	Integer	0	返回状态码。0 表示成功。
Message	String	success	返回消息。
RuleId	Long	136734987028564****	限流规则的 ID。

示例

请求示例

创建按 SQL 文本匹配的并发限流规则

返回示例

请求示例 2

创建按关键字匹配的 QPS 限流规则

返回示例 2

请求示例 3

创建按全部 SQL 匹配的 QPS 限流规则（默认 ErrorIfExists）

返回示例 3

请求示例 4

创建按全部 SQL 匹配的 QPS 限流规则（指定 Overwrite 可重复设置）

返回示例 4

错误码

更多详情，请参见错误码。

最近更新时间：2026.08.25 12:34:59

这个页面对您有帮助吗？

有用

有用

无用

无用