使用DescribeSQLPatterns查詢SQL模式列表-雲原生資料倉儲AnalyticDB-阿里雲 - AnalyticDB

調用DescribeSQLPatterns介面查看指定日期內AnalyticDB MySQL版叢集下的SQL Pattern列表。

介面說明

中心的公網接入地址：adb.aliyuncs.com。
地區的公網接入地址：adb.<region-id>.aliyuncs.com。樣本：adb.cn-hangzhou.aliyuncs.com。
地區的 VPC 接入地址：adb-vpc.<region-id>.aliyuncs.com。樣本：adb-vpc.cn-hangzhou.aliyuncs.com。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribeSQLPatterns

list

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有 AnalyticDB MySQL 叢集的詳情，包括叢集 ID。	am-bp1r053byu48p****
StartTime	string	是	查詢開始時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明僅支援查看最近 14 天的資料。例如：目前時間為 2021-11-22T12:00:00Z，最早可以查詢到 2021-11-09T12:00:00Z 的資料。查詢開始時間和查詢結束時間的間隔不能大於 24 小時。	2021-09-30T00:10:00Z
EndTime	string	是	查詢結束時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明查詢結束時間需晚於查詢開始時間。	2021-09-30T00:15:00Z
RegionId	string	是	地區 ID。說明您可以調用 DescribeRegions 介面查看 AnalyticDB MySQL 版支援的地區和可用性區域資訊，包括地區 ID。	cn-hangzhou
Keyword	string	否	SQL 關鍵字。	SELECT
Order	string	是	將查詢結果按指定欄位進行排序。格式為 JSON 字串，例如`[{"Field":"AverageQueryTime","Type":"Asc"}]`。其中： `Field`表示排序欄位。取值說明： `PatternCreationTime`：查詢時間範圍內，Pattern 的最早提交時間。 `AverageQueryTime`：查詢時間範圍內，Pattern 的平均總耗時。 `MaxQueryTime`：查詢時間範圍內，Pattern 的最大總耗時。 `AverageExecutionTime`: 查詢時間範圍內，Pattern 的平均執行耗時。 `MaxExecutionTime`: 查詢時間範圍內，Pattern 的最大執行耗時。 `AveragePeakMemory`: 查詢時間範圍內，Pattern 的平均峰值記憶體。 `MaxPeakMemory`: 查詢時間範圍內，Pattern 的最大峰值記憶體。 `AverageScanSize`: 查詢時間範圍內，Pattern 的平均資料讀取量。 `MaxScanSize`: 查詢時間範圍內，Pattern 的最巨量資料讀取量。 `QueryCount`: 查詢時間範圍內，Pattern 的執行次數。 `FailedCount`: 查詢時間範圍內，Pattern 的失敗次數。 `Type`表示排序方式。取值說明（取值不區分大小寫）： `Asc`：升序排序。 `Desc`：降序排序。	[{"Field":"AverageQueryTime","Type":"Asc"}]
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值。說明本參數不填寫，預設為 1。	1
PageSize	integer	否	每頁記錄數，取值說明： 30 50 100 說明本參數不填寫，預設為 30。	30
Lang	string	否	設定下載檔案的檔案標題以及部分錯誤資訊的語言，取值說明： zh：簡體中文（預設語言）。 en：英文。 ja：日文。 zh-tw：繁體中文。	zh
UserName	string	否	使用者名稱。	test_user
SqlPatternHash	integer	否

返回參數

名稱	類型	描述	樣本值
	object	列表資訊。
PageNumber	integer	頁數。	1
PageSize	integer	本頁記錄數。	30
TotalCount	integer	總記錄數。	1
PatternDetails	array<object>	SQL Pattern 的詳細資料。
	object	列表。
SQLPattern	string	SQL Pattern 的具體語句。	SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
PatternId	string	SQL Pattern 的 ID。	5575924945138******
User	string	提交 Pattern 相關的 SQL 資料庫使用者名稱。	reporter
AccessIp	string	提交 Pattern 相關的 SQL 用戶端 IP 位址。	192.168.xx.xx
Tables	string	SQL Pattern 掃描的資料庫表名。	tpch.orders
PatternCreationTime	string	查詢時間範圍內，Pattern 的最早提交時間。單位：毫秒。	2021-11-12 03:06:00
AverageQueryTime	number	查詢時間範圍內，Pattern 的平均總耗時。單位：毫秒。	4
MaxQueryTime	integer	查詢時間範圍內，Pattern 的最大總耗時。單位：毫秒。	2341
AverageExecutionTime	number	查詢時間範圍內，Pattern 的平均執行耗時。單位：毫秒。	234.78
MaxExecutionTime	integer	查詢時間範圍內，Pattern 的最大執行耗時。單位：毫秒。	2142
AveragePeakMemory	number	查詢時間範圍內，Pattern 的平均峰值記憶體。單位：Byte。	234.22
MaxPeakMemory	integer	查詢時間範圍內，Pattern 的最大峰值記憶體。單位：Byte。	234149
AverageScanSize	number	查詢時間範圍內，Pattern 的平均掃描量。單位：Byte。	234149.23
MaxScanSize	integer	查詢時間範圍內，Pattern 的最大掃描量。單位：Byte。	234149
QueryCount	integer	查詢時間範圍內，Pattern 的執行次數。	345
FailedCount	integer	查詢時間範圍內，Pattern 的失敗次數。	234
Blockable	boolean	能否攔截當前 SQL Pattern 的運行。取值說明： true：支援攔截。 false：不支援攔截。說明目前 AnalyticDB MySQL 版僅支援 Select 和 Insert 相關語句的攔截。	true
QueryTimeSum	number	耗時總量。單位：毫秒。	5
QueryTimePercentage	number	單個 Pattern 在查詢時間範圍內的耗時總量，在所有 Pattern 中的佔比。單位：%。	10
PeakMemorySum	number	峰值記憶體總量，單位：Byte。	5
PeakMemoryPercentage	number	峰值記憶體總量佔比。單位：%。	10
ScanSizeSum	number	資料掃描總量。單位：Byte。	5
ScanSizePercentage	number	資料掃描總量佔比。單位：%。	80
AverageOperatorCost	number	平均 CPU Cost。單位：毫秒。	5
MaxOperatorCost	number	最大 CPU Cost。單位：毫秒。	5
OperatorCostSum	number	CPU Cost 總量。單位：毫秒。	5
OperatorCostPercentage	number	CPU Cost 總量佔比。單位：%。	20
AverageScanCost	number	平均表掃描 CPU Cost。單位：毫秒。	5
MaxScanCost	number	最大表掃描 CPU Cost。單位：毫秒。	5
ScanCostSum	number	資料掃描 Cost 總量。單位：Byte。	5
ScanCostPercentage	number	資料掃描 Cost 總量佔比。單位：%。	5
RequestId	string	請求 ID。	6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******

樣本

正常返回樣本

JSON格式

{
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "PatternDetails": [
    {
      "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
      "PatternId": "5575924945138******",
      "User": "reporter",
      "AccessIp": "192.168.xx.xx",
      "Tables": "tpch.orders",
      "PatternCreationTime": "2021-11-12 03:06:00",
      "AverageQueryTime": 4,
      "MaxQueryTime": 2341,
      "AverageExecutionTime": 234.78,
      "MaxExecutionTime": 2142,
      "AveragePeakMemory": 234.22,
      "MaxPeakMemory": 234149,
      "AverageScanSize": 234149.23,
      "MaxScanSize": 234149,
      "QueryCount": 345,
      "FailedCount": 234,
      "Blockable": true,
      "QueryTimeSum": 5,
      "QueryTimePercentage": 10,
      "PeakMemorySum": 5,
      "PeakMemoryPercentage": 10,
      "ScanSizeSum": 5,
      "ScanSizePercentage": 80,
      "AverageOperatorCost": 5,
      "MaxOperatorCost": 5,
      "OperatorCostSum": 5,
      "OperatorCostPercentage": 20,
      "AverageScanCost": 5,
      "MaxScanCost": 5,
      "ScanCostSum": 5,
      "ScanCostPercentage": 5
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

錯誤碼

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

變更歷史

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