文档

GetAutoThrottleRules - 获取自动SQL限流规则

更新时间:

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

接口说明

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

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 目标数据库实例为:
    • RDS MySQL 5.6、5.7、 8.0 高可用系列、三节点企业系列。
    • PolarDB MySQL 版 5.6 集群版、5.7 集群版、 8.0 集群版、8.0 高压缩引擎(X-Engine)。

调试

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

授权信息

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

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

请求参数

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

备用参数。

None
InstanceIdsstring

数据库实例 ID。

  • 数据格式为 JSONArray,例如['实例 ID1','实例 ID2'],实例 ID 间用英文逗号(,)分隔。
  • 不输入数据库实例 ID 时,默认返回当前账号曾经开启过自动 SQL 限流功能的全部数据库实例信息,包括:
    • 正在使用该功能的数据库实例。
    • 已关闭该功能的数据库实例(不包含已经释放的数据库实例)。
['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****']

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Messagestring

请求返回消息。

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

返回的数据。

TotalAutoThrottleRulesCountlong

所有开启过自动 SQL 限流功能的数据库数量。

3
EnableAutoThrottleCountlong

正在使用自动 SQL 限流功能的数据库实例数量。

1
TurnOffAutoThrottleCountlong

曾经开启并且当前已关闭自动 SQL 限流功能的数据库实例数量。

1
NeverEnableAutoThrottleOrReleasedInstanceCountlong

从未开启过自动 SQL 限流或者实例不存在的数据库实例数量。

说明 实例不存在:数据库实例已经释放或者传入的数据库实例 ID 存在错误。
1
EnableAutoThrottleListobject []

正在使用自动 SQL 限流功能的数据库实例信息列表。

AbnormalDurationdouble

触发自动限 SQL 流规则的异常的持续时间阈值,单位:分钟。

2
CpuUsagedouble

CPU 利用率阈值。

70
CpuSessionRelationstring

CPU 利用率阈值和活跃会话数阈值的逻辑关系:

  • AND:且。
  • OR:或。
AND
ActiveSessionslong

活跃会话数量阈值。

32
MaxThrottleTimedouble

最大限流时长,单位:分钟。

10
AllowThrottleStartTimestring

可限流时间段的开始时间(UTC 时间)。

00:00Z
AllowThrottleEndTimestring

可限流时间段的结束时间(UTC 时间)。

23:59Z
Visibleboolean

自动 SQL 限流规则是否开启:

  • true:是。
  • false:否。
true
AutoKillSessionboolean

是否同时 KILL 执行中的异常 SQL:

说明 异常 SQL:与需要限流的 SQL 模板相同。
  • true:是。
  • false:否。
true
InstanceIdstring

数据库实例 ID。

rm-2ze8g2am97624****
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

140692647406****
TurnOffAutoThrottleListobject []

曾经开启并且当前已关闭自动 SQL 限流功能的数据库实例信息列表。

AbnormalDurationdouble

触发自动限流规则的持续时间阈值,单位:分钟。

2
CpuUsagedouble

CPU 利用率阈值。

80
AllowThrottleEndTimestring

可限流时间段的结束时间(UTC 时间)。

23:59Z
InstanceIdstring

数据库实例 ID。

rm-2ze9xrhze0709****
Visibleboolean

自动 SQL 限流规则是否开启:

  • true:是。
  • false:否。
false
CpuSessionRelationstring

CPU 利用率阈值和活跃会话数阈值的关系:

  • AND:且。
  • OR:或。
OR
AutoKillSessionboolean

是否同时 KILL 执行中的异常 SQL:

说明 异常 SQL:与需要限流的 SQL 模板相同。
  • true:是。
  • false:否。
true
ActiveSessionslong

活跃会话数阈值。

64
MaxThrottleTimedouble

最大限流时长,单位:分钟。

10
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

140692647406****
AllowThrottleStartTimestring

可限流时间段的开始时间(UTC 时间)。

00:00Z
NeverEnableAutoThrottleOrReleasedInstanceIdListarray

从未开启过自动 SQL 限流或者实例不存在的数据库实例数量。

说明 实例不存在:数据库实例已经释放或者传入的数据库实例 ID 存在错误。
string

数据库实例 ID。

rm-2vc54m2a6pd6p****
RequestIdstring

请求 ID。

7172BECE-588A-5961-8126-C216E16B****
Successboolean

请求是否执行成功:

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

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

变更历史

变更时间变更内容概要操作
2023-11-17API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-11-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)