GetAutoThrottleRules - 获取自动SQL限流规则 - 数据库自治服务 DAS

获取指定数据库实例的自动SQL限流规则。

接口说明

使用该接口需满足以下前提条件：

在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
目标数据库实例为：
- RDS MySQL 5.6、5.7、 8.0 高可用系列、三节点企业系列。
- PolarDB MySQL 版 5.6 集群版、5.7 集群版、 8.0 集群版。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ConsoleContext	string	否	备用参数。	None
InstanceIds	string	否	数据库实例 ID。数据格式为 JSONArray，例如`['实例 ID1','实例 ID2']`，实例 ID 间用英文逗号（,）分隔。不输入数据库实例 ID 时，默认返回当前账号曾经开启过自动 SQL 限流功能的全部数据库实例信息，包括：正在使用该功能的数据库实例。已关闭该功能的数据库实例（不包含已经释放的数据库实例）。	['rm-2ze8g2am97624**','rm-2vc54m2a6pd6p','rm-2ze9xrhze0709**']

返回参数

名称	类型	描述	示例值
	object
Code	long	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Data	object	返回的数据。
TotalAutoThrottleRulesCount	long	所有开启过自动 SQL 限流功能的数据库数量。	3
EnableAutoThrottleCount	long	正在使用自动 SQL 限流功能的数据库实例数量。	1
TurnOffAutoThrottleCount	long	曾经开启并且当前已关闭自动 SQL 限流功能的数据库实例数量。	1
NeverEnableAutoThrottleOrReleasedInstanceCount	long	从未开启过自动 SQL 限流或者实例不存在的数据库实例数量。说明实例不存在：数据库实例已经释放或者传入的数据库实例 ID 存在错误。	1
EnableAutoThrottleList	array<object>	正在使用自动 SQL 限流功能的数据库实例信息列表。
enableAutoThrottleList	object
AbnormalDuration	double	触发自动限 SQL 流规则的异常的持续时间阈值，单位：分钟。	2
CpuUsage	double	CPU 利用率阈值。	70
CpuSessionRelation	string	CPU 利用率阈值和活跃会话数阈值的逻辑关系： AND：且。 OR：或。	AND
ActiveSessions	long	活跃会话数量阈值。	32
MaxThrottleTime	double	最大限流时长，单位：分钟。	10
AllowThrottleStartTime	string	可限流时间段的开始时间（UTC 时间）。	00:00Z
AllowThrottleEndTime	string	可限流时间段的结束时间（UTC 时间）。	23:59Z
Visible	boolean	自动 SQL 限流规则是否开启： true：是。 false：否。	true
AutoKillSession	boolean	是否同时 KILL 执行中的异常 SQL：说明异常 SQL：与需要限流的 SQL 模板相同。 true：是。 false：否。	true
InstanceId	string	数据库实例 ID。	rm-2ze8g2am97624****
UserId	string	用户 ID，即创建数据库实例的阿里云主账号 ID。	140692647406****
TurnOffAutoThrottleList	array<object>	曾经开启并且当前已关闭自动 SQL 限流功能的数据库实例信息列表。
turnOffAutoThrottleList	object
AbnormalDuration	double	触发自动限流规则的持续时间阈值，单位：分钟。	2
CpuUsage	double	CPU 利用率阈值。	80
AllowThrottleEndTime	string	可限流时间段的结束时间（UTC 时间）。	23:59Z
InstanceId	string	数据库实例 ID。	rm-2ze9xrhze0709****
Visible	boolean	自动 SQL 限流规则是否开启： true：是。 false：否。	false
CpuSessionRelation	string	CPU 利用率阈值和活跃会话数阈值的关系： AND：且。 OR：或。	OR
AutoKillSession	boolean	是否同时 KILL 执行中的异常 SQL：说明异常 SQL：与需要限流的 SQL 模板相同。 true：是。 false：否。	true
ActiveSessions	long	活跃会话数阈值。	64
MaxThrottleTime	double	最大限流时长，单位：分钟。	10
UserId	string	用户 ID，即创建数据库实例的阿里云主账号 ID。	140692647406****
AllowThrottleStartTime	string	可限流时间段的开始时间（UTC 时间）。	00:00Z
NeverEnableAutoThrottleOrReleasedInstanceIdList	array	从未开启过自动 SQL 限流或者实例不存在的数据库实例数量。说明实例不存在：数据库实例已经释放或者传入的数据库实例 ID 存在错误。
neverEnableAutoThrottleOrReleasedInstanceIdList	string	数据库实例 ID。	rm-2vc54m2a6pd6p****
RequestId	string	请求 ID。	7172BECE-588A-5961-8126-C216E16B****
Success	boolean	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TotalAutoThrottleRulesCount": 3,
    "EnableAutoThrottleCount": 1,
    "TurnOffAutoThrottleCount": 1,
    "NeverEnableAutoThrottleOrReleasedInstanceCount": 1,
    "EnableAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 70,
        "CpuSessionRelation": "AND",
        "ActiveSessions": 32,
        "MaxThrottleTime": 10,
        "AllowThrottleStartTime": "00:00Z",
        "AllowThrottleEndTime": "23:59Z",
        "Visible": true,
        "AutoKillSession": true,
        "InstanceId": "rm-2ze8g2am97624****",
        "UserId": "140692647406****"
      }
    ],
    "TurnOffAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 80,
        "AllowThrottleEndTime": "23:59Z",
        "InstanceId": "rm-2ze9xrhze0709****",
        "Visible": false,
        "CpuSessionRelation": "OR",
        "AutoKillSession": true,
        "ActiveSessions": 64,
        "MaxThrottleTime": 10,
        "UserId": "140692647406****",
        "AllowThrottleStartTime": "00:00Z"
      }
    ],
    "NeverEnableAutoThrottleOrReleasedInstanceIdList": [
      "rm-2vc54m2a6pd6p****"
    ]
  },
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

变更时间	变更内容概要	操作
2023-11-17	API 内部配置变更，不影响调用	查看变更详情
2023-11-17	OpenAPI 错误码发生变更	查看变更详情