首页 数据库自治服务 DAS 开发参考 API参考 API目录 SQL限流 GetSqlConcurrencyControlRulesHistory - 获取正在执行或被触发过的限流规则

GetSqlConcurrencyControlRulesHistory - 获取正在执行或被触发过的限流规则

更新时间: 2023-08-15 16:03:07

调用GetSqlConcurrencyControlRulesHistory接口,获取正在执行或被触发过的限流规则。

接口说明

本接口适用的数据库引擎为:

  • RDS MySQL
  • PolarDB MySQL版

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:GetSqlConcurrencyControlRulesHistoryRead
  • DAS
    acs:hdm:*:{#accountId}:*

请求参数

名称类型必填描述示例值
ConsoleContextstring

备用参数。

None
InstanceIdstring

实例ID。

说明 仅支持RDS MySQL和 PolarDB MySQL版实例。
rm-2ze1jdv45i7l6****
PageNolong

页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。

1
PageSizelong

每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。

10

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Dataobject

详细信息列表,包括信息总数、错误码等。

Totallong

总记录数。

4
Listobject []

详细信息列表。

ItemIdlong

当前实例的限流规则ID。

16
SqlTypestring

选择SQL的类型。取值:

  • SELECT
  • UPDATE
  • DELETE
SELECT
InstanceIdstring

实例ID。

rm-2ze1jdv45i7l6****
SqlKeywordsstring

需要限流的SQL关键词。

说明 多个关键词间以波浪线(~)分隔,SQL语句中需要同时包含这些关键词才会触发限流规则。
call~open~api~test~4~from~POP
StartTimelong

获取限流规则历史的开始时间,格式为Unix时间戳,单位为毫秒。

1608888296000
KeywordsHashstring

哈希值,根据输入的限流关键词计算出来的值。

b0b8aceeb43baea87b219c81767b****
ConcurrencyControlTimelong

SQL限流的生效时长,单位为秒。

说明 限流规则仅在生效时间内开启。
600
UserIdstring

用户ID。

testxxx
MaxConcurrencylong

SQL最大并发数,取值为大于或等于1的整数。

说明 当包含关键词的SQL达到最大并发数时会触发限流策略。
2
Statusstring

限流规则的生效状态,取值:

  • Open:限流规则正在生效中。
  • Closed:限流规则已执行结束。
Open
RequestIdstring

请求ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

请求是否执行成功:

  • true:执行成功
  • false:执行失败
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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 数据库自治服务 DAS 相关技术圈