本文导读

展开导读

文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 创建SQL限流规则

创建SQL限流规则

更新时间：2024-08-05 GMT+08:00

查看PDF

功能介绍

添加SQL限流规则。目前仅支持MySQL数据库。使用限制如下：

规则举例详细说明：例如关键字是"select~a", 含义为：select以及a为该并发控制所包含的两个关键字，~为关键字间隔符，即若执行SQL命令包含select与a两个关键字视为命中此条并发控制规则。
当SQL语句匹配多条限流规则时，优先生效最新添加的规则，之前的规则不再生效。
限流规则关键字有顺序要求，只会按顺序匹配。如：a~and~b 只会匹配 xxx a>1 and b>2，而不会匹配 xxx b>2 and a>1。
关键字可能大小写敏感，请执行 "show variables like 'rds_sqlfilter_case_sensitive'或者到实例参数设置页面进行确认。
部分版本只读实例不允许设置限流规则，如果要设置限流规则，请到主实例上进行添加。
系统表不限制、不涉及数据查询的不限制、root账号在特定版本下不限制。

URI

POST /v3/{project_id}/instances/{instance_id}/sql-limit/rules

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。
instance_id	是	String	实例ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户token。
X-Language	否	String	语言。枚举值： zh-cn en-us

表3 请求Body参数
参数	是否必选	参数类型	描述
datastore_type	是	String	数据库类型。枚举值： MySQL
sql_limit_rules	是	Array of CreateSqlLimitRuleOption objects	需要创建的SQL限流规则列表，一次最多创建5个。
database_name	否	String	数据库名。

表4 CreateSqlLimitRuleOption
参数	是否必选	参数类型	描述
sql_type	是	String	SQL类型。枚举值： SELECT UPDATE DELETE
max_concurrency	是	Integer	最大并发数。
pattern	是	String	SQL限流规则。限流规则以~分隔关键字，例如select~a。规则举例详细说明：例如关键字是"select~a", 含义为：select以及a为该并发控制所包含的两个关键字，~为关键字间隔符，即若执行SQL命令包含select与a两个关键字视为命中此条并发控制规则。
max_waiting	否	Integer	最大等待时间。
his_sql_limit_switch	否	Boolean	历史SQL限流开关。本开关仅对本条SQL限流规则生效。开启时，将kill掉命中此条SQL限流规则的已有会话。

响应参数

状态码： 400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。最小长度：8 最大长度：36
error_msg	String	错误描述。最小长度：2 最大长度：512

状态码： 500

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。最小长度：8 最大长度：36
error_msg	String	错误描述。最小长度：2 最大长度：512

请求示例

创建SQL限流规则。

POST https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances/d871e13ee1044e21a473330cd67047cbin01/sql-limit/rules

{
  "sql_limit_rules" : [ {
    "sql_type" : "SELECT",
    "pattern" : "select~t2~var",
    "max_concurrency" : 100
  }, {
    "sql_type" : "DELETE",
    "pattern" : "delete~t1~name",
    "max_concurrency" : 1
  } ],
  "datastore_type" : "MySQL"
}

响应示例

无。

状态码

状态码	描述
200	Success.
400	Client error.
500	Client error.

错误码

请参见错误码。

父主题： 云DBA

上一篇：根据原始SQL生成SQL限流关键字

下一篇：删除SQL限流规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消