GetAutoThrottleRules - 数据库自治服务 DAS

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

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

请求参数


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

返回数据


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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetAutoThrottleRules
&InstanceIds=['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****']
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误

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