调用GetSqlConcurrencyControlRulesHistory接口,获取正在执行或被触发过的限流规则。
接口说明
本接口适用的数据库引擎为:
RDS MySQL
PolarDB MySQL 版
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hdm:GetSqlConcurrencyControlRulesHistory |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ConsoleContext |
string |
否 |
备用参数。 |
None |
| InstanceId |
string |
是 |
实例 ID。 说明
仅支持 RDS MySQL 和 PolarDB MySQL 版实例。 |
rm-2ze1jdv45i7l6**** |
| PageNo |
integer |
否 |
页码,取值大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。 |
1 |
| PageSize |
integer |
否 |
每页最大记录数,取值大于 0 且不超过 Integer 数据类型的最大值,默认值为 10。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
返回的状态码。 |
200 |
| Message |
string |
请求返回消息。 说明
请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Successful |
| Data |
object |
详细信息列表,包括信息总数、错误码等。 |
|
| Total |
integer |
总记录数。 |
4 |
| List |
object |
||
| rules |
array<object> |
详细信息列表。 |
|
|
object |
|||
| ItemId |
integer |
当前实例的限流规则 ID。 |
16 |
| SqlType |
string |
选择 SQL 的类型。取值:
|
SELECT |
| InstanceId |
string |
实例 ID。 |
rm-2ze1jdv45i7l6**** |
| SqlKeywords |
string |
需要限流的 SQL 关键词。 说明
多个关键词间以波浪线(~)分隔,SQL 语句中需要同时包含这些关键词才会触发限流规则。 |
call~open~api~test~4~from~POP |
| StartTime |
integer |
获取限流规则历史的开始时间,格式为 Unix 时间戳,单位为毫秒。 |
1608888296000 |
| KeywordsHash |
string |
哈希值,根据输入的限流关键词计算出来的值。 |
b0b8aceeb43baea87b219c81767b**** |
| ConcurrencyControlTime |
integer |
SQL 限流的生效时长,单位为秒。 说明
限流规则仅在生效时间内开启。 |
600 |
| UserId |
string |
用户 ID。 |
testxxx |
| MaxConcurrency |
integer |
SQL 最大并发数,取值为大于或等于 1 的整数。 说明
当包含关键词的 SQL 达到最大并发数时会触发限流策略。 |
2 |
| Status |
string |
限流规则的生效状态,取值:
|
Open |
| RequestId |
string |
请求 ID。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
请求是否执行成功:
|
true |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "Successful",
"Data": {
"Total": 4,
"List": {
"rules": [
{
"ItemId": 16,
"SqlType": "SELECT",
"InstanceId": "rm-2ze1jdv45i7l6****",
"SqlKeywords": "call~open~api~test~4~from~POP",
"StartTime": 1608888296000,
"KeywordsHash": "b0b8aceeb43baea87b219c81767b****",
"ConcurrencyControlTime": 600,
"UserId": "testxxx",
"MaxConcurrency": 2,
"Status": "Open"
}
]
}
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
| 403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。