文档中心

AI 原生 BaaS 平台 Supabase 版

SQL 限流

DescribeSQLConcurrencyControlRules

调用 DescribeSQLConcurrencyControlRules 接口查询 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	数据库的名称。
MatchType	String	否	keywords	按运行时匹配类型过滤。取值： query_id keywords all
QueryId	Long	否	12345	按 query_id 过滤。
QueryString	String	否	SELECT * FROM	按 SQL 文本过滤，最小长度为 1 个字符。
Keywords	Array of String	否	["slow_query"]	按关键字过滤。
LimitType	String	否	concurrency	按限流类型过滤。取值： concurrency：并发数限流。 qps：QPS 限流。
OverLimitAction	String	否	reject	限流规则超限时的处置方式。取值： reject：拒绝请求。仅 QPS 限流支持。 queue：排队等待。仅并发限流支持。
NodeType	String	否	Primary	规则生效的节点范围。取值： Primary：主节点。 Standby：备节点。 All：全部节点。
Enabled	Boolean	否	true	按启用状态过滤。取值： true：是。 false：否。
Offset	Integer	否	0	分页偏移量，默认值为 0。
Limit	Integer	否	20	每页数量。取值范围为 1～100。

返回参数

参数	类型	示例值	描述
Code	Integer	0	返回状态码。0 表示成功。
Message	String	success	返回消息。
TotalCount	Long	5	符合条件的规则总数。
Rules	Array of SQLConcurrencyControlRuleInfo	[{"RuleId":136734987028564****,"MatchType":"keywords","LimitType":"concurrency","Enabled":true}]	限流规则详情列表。

SQLConcurrencyControlRuleInfo

参数	类型	示例值	描述
QPS	Integer	100	每秒允许通过的请求数。
Burst	Integer	200	Token Bucket 桶容量。
RuleId	Long	136734987028564****	限流规则 ID。
Comment	String	限制慢查询并发	规则注释。
Enabled	Boolean	true	规则是否启用。
QueryId	Long	12345	query_id 规则的最终匹配值。
Keywords	Array of String	["slow_query"]	keywords 规则的关键字数组。
NodeType	String	All	规则生效的节点范围。取值： Primary：主节点。 Standby：备节点。 All：全部节点。
CreatedAt	String	2026-01-01T00:00:00Z	规则创建时间。
LimitType	String	concurrency	规则的限流类型。取值： concurrency：并发数限流。 qps：QPS 限流。
MatchType	String	keywords	运行时匹配类型。取值： query_id keywords all
MaxWaitMs	Integer	1000	并发限流最大等待时间，单位为毫秒。0 表示不限制等待时间。
UpdatedAt	String	2026-01-01T00:00:00Z	规则更新时间。
MaxWaiting	Integer	20	并发限流最大等待数。
SearchPath	String	public	限流规则为按 SQL 文本匹配时，计算 SQL 文本对应的 queryId 时使用的 search_path，最大长度为 256 个字符。
QueryString	String	SELECT * FROM orders	用户通过 SQL 文本创建规则时的原始 SQL，仅用于审计和重新计算。
MaxConcurrency	Integer	10	并发限流最大并发数。
OverLimitAction	String	reject	限流规则超限时的处置方式。取值： reject：拒绝请求。仅 QPS 限流支持。 queue：排队等待。仅并发限流支持。

示例

请求示例

返回示例

错误码

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

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

这个页面对您有帮助吗？

有用

无用