調用DescribePatternPerformance API擷取SQL Pattern的效能指標-雲原生資料倉儲AnalyticDB-阿里雲

調用DescribePatternPerformance介面查看指定時間段內SQL Pattern的各指標（如查詢時間、平均記憶體消耗）詳情。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribePatternPerformance

get

DBCluster

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有 AnalyticDB MySQL 叢集的詳情，包括叢集 ID。	am-****************
StartTime	string	是	查詢開始時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明僅支援查看最近 14 天內的資料。例如：當前日期為北京時間 11 月 22 日，最早可以查詢到北京時間 11 月 9 日（UTC 時間：2021-11-08T16:00:00Z)的資料，若查詢時間早於 11 月 9 日（UTC 時間：2021-11-08T16:00:00Z)，傳回值為空白。查詢開始時間和查詢結束時間的間隔不能大於 24 小時。	2021-11-18T00:00:00Z
EndTime	string	是	查詢結束時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明查詢結束時間需晚於查詢開始時間。	2021-11-18T18:05:00Z
RegionId	string	是	地區 ID。說明您可以調用 DescribeRegions 介面查看 AnalyticDB MySQL 版支援的地區和可用性區域資訊，包括地區 ID。	cn-hangzhou
PatternId	string	是	SQL Pattern 的 ID。說明您可以調用 DescribeSQLPatterns 介面查看指定時間內目標 AnalyticDB MySQL 叢集下所有的 SQL Pattern 列表資訊，包括 SQL Pattern 的 ID。	3847585356974******

返回參數

名稱	類型	描述	樣本值
	object	列表。
EndTime	string	查詢結束時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-11-18T18:05Z
RequestId	string	請求 ID。	210f47011634026610213529******
StartTime	string	查詢開始時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-11-18T00:00Z
Performances	array<object>	效能指標列表。
	array<object>	列表。
Key	string	查詢的效能指標項。取值說明： AnalyticDB_PatternQueryCount：Pattern 相關查詢的總次數。 AnalyticDB_PatternQueryTime：Pattern 相關查詢的總耗時。 AnalyticDB_PatternExecutionTime：Pattern 相關查詢的執行耗時。 AnalyticDB_PatternPeakMemory：Pattern 相關查詢的峰值記憶體。 AnalyticDB_PatternScanSize：Pattern 相關查詢的資料讀取量。	AnalyticDB_PatternQueryCount
Unit	string	效能指標項對應的單位。取值說明：當效能指標項為查詢時間相關（即`Key`值為`AnalyticDB_PatternQueryTime`或`AnalyticDB_PatternExecutionTime`）時，該傳回值為 ms。當效能指標項為峰值記憶體相關（即`Key`值為`AnalyticDB_PatternPeakMemory`）時，該傳回值為 MB。當效能指標項為資料讀取量（即`Key`值為`AnalyticDB_PatternScanSize`）時，該傳回值為 MB。當效能指標項為查詢次數（即`Key`值為`AnalyticDB_PatternQueryCount`）時，該傳回值為空白。	ms
Series	array<object>	效能指標項下各效能值的詳情。
	object	列表。
Values	array	效能值列表。
	string	效能值。	[ "2021-11-18 13:38:00", "224" ]
Name	string	效能值名稱。取值說明：當`Key`值為`AnalyticDB_PatternQueryCount`時，該參數返回 `pattern_query_count`，即當前 Pattern 相關 SQL 的執行次數。當`Key`值為`AnalyticDB_PatternQueryTime`時，該參數返回： `average_query_time`，即當前 Pattern 相關 SQL 的平均總耗時。 `max_query_time`，即當前 Pattern 相關 SQL 的最大總耗時。當`Key`值為`AnalyticDB_PatternExecutionTime`時，該參數返回： `average_execution_time`，即當前 Pattern 相關 SQL 的平均執行耗時。 `max_execution_time`，即當前 Pattern 相關 SQL 的最大執行耗時。當`Key`值為`AnalyticDB_PatternPeakMemory`時，該參數返回： `average_peak_memory`，即當前 Pattern 相關 SQL 的平均峰值記憶體。 `max_peak_memory`，即當前 Pattern 相關 SQL 的最大峰值記憶體。當`Key`值為`AnalyticDB_PatternScanSize`時，該參數返回： `average_scan_size`，即當前 Pattern 相關 SQL 的平均讀取資料量。 `max_scan_size`，即當前 Pattern 相關 SQL 的最巨量資料讀取量。	max_query_time
AccessIp	string	提交 Pattern 相關的 SQL 用戶端 IP 位址。	172.16.14.*
FailedCount	integer	查詢時間範圍內，Pattern 的失敗次數。	0
QueryCount	integer	指定時間範圍內，Pattern 的執行次數。	35018
SQLPattern	string	SQL Pattern 的具體語句。	SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?
Tables	string	SQL Pattern 查詢涉及的表資訊。	tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation
User	string	執行 SQL 陳述式的使用者名稱。	test

樣本

正常返回樣本

JSON格式

{
  "EndTime": "2021-11-18T18:05Z",
  "RequestId": "210f47011634026610213529******",
  "StartTime": "2021-11-18T00:00Z",
  "Performances": [
    {
      "Key": "AnalyticDB_PatternQueryCount",
      "Unit": "ms",
      "Series": [
        {
          "Values": [
            "[               \"2021-11-18 13:38:00\",               \"224\"             ]"
          ],
          "Name": "max_query_time"
        }
      ]
    }
  ],
  "AccessIp": "172.16.14.*",
  "FailedCount": 0,
  "QueryCount": 35018,
  "SQLPattern": "SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?",
  "Tables": "tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation",
  "User": "test"
}

錯誤碼

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

變更歷史

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