调用GetSqlConcurrencyControlRulesHistory接口,获取正在执行或被触发过的限流规则。
本接口适用的数据库引擎为:
- RDS MySQL
- PolarDB MySQL版
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetSqlConcurrencyControlRulesHistory | 系统规定参数。取值:GetSqlConcurrencyControlRulesHistory。 |
ConsoleContext | String | 否 | None | 备用参数。 |
InstanceId | String | 是 | rm-2ze1jdv45i7l6**** | 实例ID。 说明 仅支持RDS MySQL和 PolarDB MySQL版实例。 |
PageNo | Long | 否 | 1 | 页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Long | 否 | 10 | 每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 | 返回的状态码。 |
Message | String | Successful | 请求返回消息。 说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Data | Object | 详细信息列表,包括信息总数、错误码等。 |
|
Total | Long | 4 | 总记录数。 |
List | Array of rules | 详细信息列表。 |
|
rules | |||
ItemId | Long | 16 | 当前实例的限流规则ID。 |
SqlType | String | SELECT | 选择SQL的类型。取值:
|
InstanceId | String | rm-2ze1jdv45i7l6**** | 实例ID。 |
SqlKeywords | String | call~open~api~test~4~from~POP | 需要限流的SQL关键词。 说明 多个关键词间以波浪线(~)分隔,SQL语句中需要同时包含这些关键词才会触发限流规则。 |
StartTime | Long | 1608888296000 | 获取限流规则历史的开始时间,格式为Unix时间戳,单位为毫秒。 |
KeywordsHash | String | b0b8aceeb43baea87b219c81767b**** | 哈希值,根据输入的限流关键词计算出来的值。 |
ConcurrencyControlTime | Long | 600 | SQL限流的生效时长,单位为秒。 说明 限流规则仅在生效时间内开启。 |
UserId | String | testxxx | 用户ID。 |
MaxConcurrency | Long | 2 | SQL最大并发数,取值为大于或等于1的整数。 说明 当包含关键词的SQL达到最大并发数时会触发限流策略。 |
Status | String | Open | 限流规则的生效状态,取值:
|
RequestId | String | B6D17591-B48B-4D31-9CD6-9B9796B2**** | 请求ID。 |
Success | String | true | 请求是否执行成功:
|
示例
请求示例
http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetSqlConcurrencyControlRulesHistory
&ConsoleContext=None
&InstanceId=rm-2ze1jdv45i7l6****
&PageNo=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetSqlConcurrencyControlRulesHistoryResponse>
<Code>200</Code>
<Message>Successful</Message>
<Data>
<Total>4</Total>
<List>
<ItemId>16</ItemId>
<SqlType>SELECT</SqlType>
<InstanceId>rm-2ze1jdv45i7l6****</InstanceId>
<SqlKeywords>call~open~api~test~4~from~POP</SqlKeywords>
<StartTime>1608888296000</StartTime>
<KeywordsHash>b0b8aceeb43baea87b219c81767b****</KeywordsHash>
<ConcurrencyControlTime>600</ConcurrencyControlTime>
<UserId>testxxx</UserId>
<MaxConcurrency>2</MaxConcurrency>
<Status>Open</Status>
</List>
</Data>
<RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
<Success>true</Success>
</GetSqlConcurrencyControlRulesHistoryResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : "200",
"Message" : "Successful",
"Data" : {
"Total" : 4,
"List" : [ {
"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"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
访问错误中心查看更多错误码。