GetAutoThrottleRules - 擷取自動SQL限流規則 -

擷取指定資料庫執行個體的自動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對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:GetAutoThrottleRules

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ConsoleContext	string	否	備用參數。	None
InstanceIds	string	否	資料庫執行個體 ID。資料格式為 JSONArray，例如`['執行個體 ID1','執行個體 ID2']`，執行個體 ID 間用英文逗號（,）分隔。不輸入資料庫執行個體 ID 時，預設返回當前帳號曾經開啟過自動 SQL 限流功能的全部資料庫執行個體資訊，包括：正在使用該功能的資料庫執行個體。已關閉該功能的資料庫執行個體（不包含已經釋放的資料庫執行個體）。	['rm-2ze8g2am97624**','rm-2vc54m2a6pd6p','rm-2ze9xrhze0709**']

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	返回的狀態代碼。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
Data	object	返回的資料。
TotalAutoThrottleRulesCount	integer	所有開啟過自動 SQL 限流功能的資料庫數量。	3
EnableAutoThrottleCount	integer	正在使用自動 SQL 限流功能的資料庫執行個體數量。	1
TurnOffAutoThrottleCount	integer	曾經開啟並且當前已關閉自動 SQL 限流功能的資料庫執行個體數量。	1
NeverEnableAutoThrottleOrReleasedInstanceCount	integer	從未開啟過自動 SQL 限流或者執行個體不存在的資料庫執行個體數量。說明執行個體不存在：資料庫執行個體已經釋放或者傳入的資料庫執行個體 ID 存在錯誤。	1
EnableAutoThrottleList	array<object>	正在使用自動 SQL 限流功能的資料庫執行個體資訊列表。
	object
AbnormalDuration	number	觸發自動限 SQL 流規則的異常的期間閾值，單位：分鐘。	2
CpuUsage	number	CPU 利用率閾值。	70
CpuSessionRelation	string	CPU 利用率閾值和活躍會話數閾值的邏輯關係： AND：且。 OR：或。	AND
ActiveSessions	integer	活躍會話數量閾值。	32
MaxThrottleTime	number	最大限流時間長度，單位：分鐘。	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。	140692647406****
TurnOffAutoThrottleList	array<object>	曾經開啟並且當前已關閉自動 SQL 限流功能的資料庫執行個體資訊列表。
	object
AbnormalDuration	number	觸發自動限流規則的期間閾值，單位：分鐘。	2
CpuUsage	number	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	integer	活躍會話數閾值。	64
MaxThrottleTime	number	最大限流時間長度，單位：分鐘。	10
UserId	string	使用者識別碼，即建立資料庫執行個體的阿里雲主帳號 ID。	140692647406****
AllowThrottleStartTime	string	可限流時間段的開始時間（UTC 時間）。	00:00Z
NeverEnableAutoThrottleOrReleasedInstanceIdList	array	從未開啟過自動 SQL 限流或者執行個體不存在的資料庫執行個體數量。說明執行個體不存在：資料庫執行個體已經釋放或者傳入的資料庫執行個體 ID 存在錯誤。
	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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。