文档中心

云数据库 PostgreSQL 版

SQL 限流

CreateSQLConcurrencyControlRule

CreateSQLConcurrencyControlRule

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

请求类型

异步请求。

注意事项

仅 2026 年 10 月 15 日及之后创建的 PostgreSQL 14～PostgreSQL 17 版本的实例支持创建 SQL 限流规则。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-5d27abexxxx	实例 ID。说明您可以调用 DescribeDBInstances接口查询实例 ID。
DatabaseName	String	是	pg_demo	目标数据库名称。
Match	Object of RuleMatch	是	请参见请求示例	匹配规则。支持按 SQL 指纹、关键字和全部 SQL 匹配。
Limit	Object of RuleConfig	是	请参见请求示例	限流配置。支持并发限流和 QPS 限流。
Action	String	是	reject	限流规则超限后的处置方式。取值： reject：拒绝请求。仅 QPS 限流支持。 queue：排队等待。仅并发限流支持。
NodeType	String	是	Primary	规则生效的节点范围。取值： Primary：主节点。 Standby：备节点。 All：全部节点。
Enabled	Boolean	否	true	创建规则后是否启用。取值： true：是。默认值。 false：否。
Comment	String	否	限制 QPS 并发	限流规则的备注信息。最大长度为 256 个字符。
SearchPath	String	否	public	限流规则为按 SQL 指纹匹配时，计算 SQL 文本对应的 queryId 时使用的 search_path。默认值为 "$user",public，最大长度为 256 个字符。

RuleMatch

参数	类型	是否必选	示例值	描述
Type	String	是	query_string	匹配类型。取值： query_string：按 SQL 指纹匹配 keywords：按关键字匹配。 all：匹配全部 SQL。
Keywords	Array of String	否	["qps_query"]	关键字。数组最多支持 512 个元素，单个关键字长度不超过 256 个字符。说明仅当 Type 参数取值为 keywords时，填写该参数。
QueryString	String	否	SELECT * FROM demo	SQL 文本。说明仅当 Type 参数取值为 query_string时，填写该参数。

RuleConfig

参数	类型	是否必选	示例值	描述
Type	String	是	qps	限流类型。取值： concurrency：并发数限流。 qps：QPS 限流。
QPS	Integer	否	100	每秒允许通过的请求数。取值范围为 0～100000。说明仅当 Type 参数取值为 qps 时，填写该参数。当 RuleMatch.Type 参数取值为 all时，该参数取值至少大于 1。
Burst	Integer	否	200	Token Bucket 桶容量。取值范围为 1～100000。说明仅当 Type 参数取值为 qps时，填写该参数。
MaxWaitMs	Integer	否	1000	最大等待时间，默认值为 0，表示不限制等待时间。单位为毫秒，取值范围为 0～864000000。说明仅当 Type 参数取值为 concurrency时，填写该参数。
MaxWaiting	Integer	否	20	最大等待排队数。取值范围为 0～100000。说明仅当 Type 参数取值为 concurrency时，填写该参数。
MaxConcurrency	Integer	否	10	最大并发数。取值范围为 0～100000。说明当 Type 参数取值为 concurrency 时，必须填写该参数。当 RuleMatch.Type 参数取值为 all时，该参数取值至少大于 1。

返回参数

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

示例

请求示例

返回示例

最近更新时间：2026.10.16 14:17:39

这个页面对您有帮助吗？

有用

有用

无用

无用