调用 DescribeSQLConcurrencyControlRules 接口查看 SQL 限流规则。

请求类型

同步请求。

注意事项

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-5d27abexxxx	实例 ID。说明您可以调用 DescribeDBInstances接口查询实例 ID。
DatabaseName	String	是	pg_demo	目标数据库名称。
MatchType	String	否	keywords	按运行时匹配类型过滤。取值： query_id。 keywords。 all。
QueryId	Long	否	12345	按 query_id 过滤。
QueryString	String	否	SELECT * FROM	按 SQL 文本过滤，最小长度为 1 个字符。
Keywords	Array of String	否	["slow_query"]	按关键字过滤。数组最多支持 512 个元素，单个关键字长度不超过 256 个字符。
LimitType	String	否	concurrency	按限流类型过滤。取值： concurrency：并发数限流。 qps：QPS 限流。
Action	String	否	reject	限流规则超限后的处置方式。取值： reject：拒绝请求。仅 QPS 限流支持。 queue：排队等待。仅并发限流支持。
NodeType	String	否	Primary	规则生效的节点范围。取值： Primary：主节点。 Standby：备节点。 All：全部节点。
Enabled	Boolean	否	true	按启用状态过滤。取值： true：启用。 false：未启用。
Offset	Integer	否	0	分页偏移量，默认值为 0。
Limit	Integer	否	20	每页数量。默认值为 100，取值范围为 1～100。

返回参数

参数	类型	示例值	描述
Code	Integer	0	返回状态码。0 表示成功。
Message	String	success	返回信息。
TotalCount	Long	5	满足过滤条件的规则总数。
Rules	Array of SQLConcurrencyControlRuleInfo	请参见返回示例	当前分页返回的规则列表。

SQLConcurrencyControlRuleInfo

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

示例

请求示例

返回示例

云数据库 PostgreSQL 版