获取正在执行的限流规则的API接口_数据库自治服务(DAS)-阿里云帮助中心

调用GetRunningSqlConcurrencyControlRules接口，获取正在执行的限流规则。

接口说明

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

RDS MySQL
PolarDB MySQL 版

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hdm:GetRunningSqlConcurrencyControlRules	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ConsoleContext	string	否	备用参数。	None
InstanceId	string	是	实例 ID。说明仅支持 RDS MySQL 和 PolarDB MySQL 版实例。	rm-2ze1jdv45i7l6****
PageNo	long	否	页码，取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
PageSize	long	否	每页最大记录数，取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 10。	10

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Data	object	详细信息列表，包括信息总数、错误码等。
Total	long	总记录数。	2
List	array<object>	返回信息列表。
runningRules	object
ItemId	long	当前实例的限流规则 ID。	16
SqlType	string	选择 SQL 的类型。取值： SELECT UPDATE DELETE	SELECT
InstanceId	string	实例 ID。	rm-2ze1jdv45i7l6****
SqlKeywords	string	需要限流的 SQL 关键词。说明多个关键词间用波浪线（~）分隔，SQL 语句中需要同时包含这些关键词才会触发限流规则。	call~open~api~test~4~from~POP
StartTime	long	获取正在执行的限流规则的开始时间，格式为 Unix 时间戳，单位为毫秒。	1608888296000
KeywordsHash	string	哈希值，根据输入的限流关键词计算出来的值。	b0b8aceeb43baea87b219c81767b****
ConcurrencyControlTime	long	SQL 限流的生效时长，单位为秒。说明限流规则仅在生效时间内开启。	600
UserId	string	阿里云账号 ID。	testxxx
MaxConcurrency	string	SQL 最大并发数，取值为大于或等于 1 的整数。说明当包含关键词的 SQL 达到最大并发数时会触发限流策略。	2
Status	string	限流规则的生效状态，取值为 Open：限流规则正在生效中。	Open
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	请求是否执行成功： true：执行成功 false：执行失败	true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 2,
    "List": {
      "runningRules": [
        {
          "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.	没有权限执行该操作

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史