全部產品
Search

搜尋本產品

    AnalyticDB：DescribeSqlPatternCompareReport

    文件中心

    AnalyticDB：DescribeSqlPatternCompareReport

    更新時間：Sep 17, 2026

    查詢 SQL Pattern 對比報告詳情。

    介面說明

    按 MetricType 分頁查詢 SQL Pattern 對比報告詳情。報告類型說明：

    • NEW：返回時間 2 新增的 Pattern，MetricValues 中返回 Time2。

    • CHANGED：返回兩個時間視窗均存在且當前維度平均值增長的 Pattern，MetricValues 中返回 Avg、Sum、Max。

    指標統計口徑：

    • Sum：有效查詢分鐘桶的指標值總和。

    • Avg：有效查詢分鐘桶的指標值平均值。

    • Max：單分鐘桶的指標值峰值。

    指標單位：

    • QUERY_COUNT：次。

    • CPU_COST：秒。

    • SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE：GB。

    說明

    • 僅 DetailEnabled 為 true 的報告可查詢詳情；未完成、已取消或已過期的報告不可查詢。

    • Percent 結尾的欄位已是百分數。時間 1 指標值為 0 時，ChangeRatePercent 可能不返回，不應視為 0%。

    • 報告按執行個體和阿里雲主帳號隔離。

    調試

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

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    執行個體所在的區域 ID。

    cn-beijing
    DBClusterId

    string

    是

    AnalyticDB for MySQL 執行個體 ID。

    am-2ze1234567890****
    ReportId

    integer

    是

    SQL Pattern 對比報告 ID。

    1001
    MetricType

    string

    是

    分析維度。取值說明：

    • QUERY_COUNT：查詢執行次數。

    • CPU_COST：CPU 消耗。

    • SHUFFLE_SIZE：Shuffle 資料量。

    • PEAK_MEMORY：峰值記憶體消耗。

    • SCAN_SIZE：掃描資料量。

    枚舉值：

    • PEAK_MEMORY :

      峰值記憶體消耗。

    • CPU_COST :

      CPU 消耗。

    • QUERY_COUNT :

      查詢執行次數。

    • SHUFFLE_SIZE :

      Shuffle 資料量。

    • SCAN_SIZE :

      掃描資料量。

    CPU_COST
    PageNumber

    integer

    否

    頁碼，從 1 開始。

    預設值：1。

    1
    PageSize

    integer

    否

    每頁列數，取值範圍：1～100。

    預設值：50。

    50
    Order

    string

    否

    將查詢結果按指定欄位排序。格式為 JSON 陣列字串，例如 [{"Field":"Time2SumValue","Type":"Desc"}]。陣列中只能包含一個物件。其中：

    • Field 表示排序欄位，區分大小寫。取值說明：

      • NEW 報告：Time2SumValue、Time2AvgValue、Time2MaxValue。

      • CHANGED 報告：AvgChangeRatePercent、AvgTime1Value、AvgTime2Value、SumChangeRatePercent、SumTime1Value、SumTime2Value、MaxChangeRatePercent、MaxTime1Value、MaxTime2Value。

      • 所有報告類型和分析維度：AvgRt、MaxRt。

      • QUERY_COUNT：TotalQueryTime。

      • CPU_COST：QueryCount、AvgPlanningTime、MaxPlanningTime、AvgExecutionTime、MaxExecutionTime。

      • SHUFFLE_SIZE、PEAK_MEMORY：QueryCount。

      • SCAN_SIZE：QueryCount、TotalScanCost。

    • Type 表示排序方式，不區分大小寫。取值說明：

      • Asc：升序排列。

      • Desc：降序排列。

    說明

    • NEW 報告預設按照 Time2SumValue 欄位降序排列。

    • CHANGED 報告預設按照 AvgChangeRatePercent 欄位降序排列。

    • Field 必須適用於目前報告類型和 MetricType。

    [{"Field":"AvgChangeRatePercent","Type":"Desc"}]
    ChangeRate

    string

    否

    CHANGED 報告的平均變化率篩選區間。格式為 left~right，數值單位為百分比，區間左開右閉。範例：

    • 100~500：大於 100% 且小於等於 500%。

    • 100~：大於 100%，無上限。

    說明

    • 左邊界必填且不得小於 0；右邊界不得小於左邊界。

    • NEW 報告忽略該參數。

    • 時間 1 指標值為 0、時間 2 大於 0 時，該 Pattern 屬於零基線成長，將歸入 SEVERE（嚴重變化）。如需排除此類 Pattern，請設定變化率上限。

    100~500
    IncludePattern

    boolean

    否

    是否回傳參數化後的 SQL Pattern 文字。取值說明：

    • true：回傳 Pattern 文字。

    • false：不回傳 Pattern 文字，可減少回應大小。

    預設值：true。

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    指定報告和分析維度的詳情分頁結果。

    Items

    array<object>

    當前頁的 Pattern 詳情；無符合條件的結果時為空陣列。

    array<object>

    一條 SQL Pattern 的當前維度分析結果。

    AvgExecutionTime

    string

    時間 2 的平均執行耗時展示字串，單位為秒，僅 CPU_COST 維度返回。

    0.4s
    AvgPlanningTime

    string

    時間 2 的平均計畫耗時展示字串，單位為秒，僅 CPU_COST 維度返回。

    0.1s
    AvgRt

    string

    時間 2 的平均查詢回應時間展示字串，單位為秒。所有分析維度均返回。

    0.5s
    MaxExecutionTime

    string

    時間 2 的最大執行耗時展示字串，單位為秒，僅 CPU_COST 維度返回。

    1.8s
    MaxPlanningTime

    string

    時間 2 的最大計畫耗時展示字串，單位為秒，僅 CPU_COST 維度返回。

    0.2s
    MaxRt

    string

    時間 2 的最大查詢回應時間展示字串，單位為秒。所有分析維度均返回。

    2s
    MetricValues

    object

    當前分析維度的主指標映射。鍵的取值說明：

    • QUERY_COUNT：查詢執行次數。

    • CPU_COST：CPU 消耗。

    • SHUFFLE_SIZE：Shuffle 資料量。

    • PEAK_MEMORY：峰值記憶體消耗。

    • SCAN_SIZE：掃描資料量。

    說明

    每條結果僅包含與請求參數 MetricType 一致的一個鍵。

    object

    一個主指標的統計結果。不同報告類型返回的欄位如下：

    • NEW 報告：返回 Time2。

    • CHANGED 報告：返回 Avg、Sum、Max。

    Avg

    object

    CHANGED 報告的有效查詢分鐘桶平均值雙視窗對比，僅 CHANGED 返回。

    ChangeRatePercent

    number

    有效查詢分鐘桶平均值變化率，計算為（時間 2 值－時間 1 值）/時間 1 值×100，200 表示增長 200%。時間 1 為 0 時無法計算有限變化率，此欄位可能不返回，不能視為 0%。

    200
    Time1DisplayValue

    string

    時間 1 的有效查詢分鐘桶平均值展示字串，含單位。

    1s
    Time1RatioPercent

    number

    此 Pattern 的時間 1 有效查詢分鐘桶平均值佔當前報告、當前維度篩選前所有結果對應統計值之和的百分比，10 表示 10%。

    10
    Time1Value

    number

    時間 1 的有效查詢分鐘桶平均值。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    1
    Time2DisplayValue

    string

    時間 2 的有效查詢分鐘桶平均值展示字串，含單位。

    3s
    Time2RatioPercent

    number

    此 Pattern 的時間 2 有效查詢分鐘桶平均值佔當前報告、當前維度篩選前所有結果對應統計值之和的百分比，10 表示 10%。

    10
    Time2Value

    number

    時間 2 的有效查詢分鐘桶平均值。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    3
    Max

    object

    CHANGED 報告的單分鐘桶峰值雙視窗對比，僅 CHANGED 返回。

    ChangeRatePercent

    number

    單分鐘桶峰值變化率，計算為（時間 2 值－時間 1 值）/時間 1 值×100，200 表示增長 200%。時間 1 為 0 時無法計算有限變化率，此欄位可能不返回，不能視為 0%。

    200
    Time1DisplayValue

    string

    時間 1 的單分鐘桶峰值展示字串，含單位。

    3s
    Time1Value

    number

    時間 1 的單分鐘桶峰值。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    3
    Time2DisplayValue

    string

    時間 2 的單分鐘桶峰值展示字串，含單位。

    9s
    Time2Value

    number

    時間 2 的單分鐘桶峰值。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    9
    MetricCode

    string

    主指標編碼，與 MetricValues 的鍵和請求參數 MetricType 一致。取值說明：

    • QUERY_COUNT：查詢執行次數。

    • CPU_COST：CPU 消耗。

    • SHUFFLE_SIZE：Shuffle 資料量。

    • PEAK_MEMORY：峰值記憶體消耗。

    • SCAN_SIZE：掃描資料量。

    CPU_COST
    MetricName

    string

    主指標名稱。對應關係如下：

    • QUERY_COUNT：QueryCount。

    • CPU_COST：OperatorCost。

    • SHUFFLE_SIZE：ShuffleSize。

    • PEAK_MEMORY：PeakMemory。

    • SCAN_SIZE：ScanSize。

    OperatorCost
    Primary

    boolean

    是否為當前分析維度的主指標，當前返回 true。

    true
    Sum

    object

    CHANGED 報告的有效查詢分鐘桶指標值總和雙視窗對比，僅 CHANGED 返回。

    ChangeRatePercent

    number

    有效查詢分鐘桶指標值總和變化率，計算為（時間 2 值－時間 1 值）/時間 1 值×100，200 表示增長 200%。時間 1 為 0 時無法計算有限變化率，此欄位可能不返回，不能視為 0%。

    200
    Time1DisplayValue

    string

    時間 1 的有效查詢分鐘桶指標值總和展示字串，含單位。

    60s
    Time1RatioPercent

    number

    此 Pattern 的時間 1 有效查詢分鐘桶指標值總和佔當前報告、當前維度篩選前所有結果對應統計值之和的百分比，10 表示 10%。

    10
    Time1Value

    number

    時間 1 的有效查詢分鐘桶指標值總和。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    60
    Time2DisplayValue

    string

    時間 2 的有效查詢分鐘桶指標值總和展示字串，含單位。

    180s
    Time2RatioPercent

    number

    此 Pattern 的時間 2 有效查詢分鐘桶指標值總和佔當前報告、當前維度篩選前所有結果對應統計值之和的百分比，10 表示 10%。

    10
    Time2Value

    number

    時間 2 的有效查詢分鐘桶指標值總和。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    180
    Time2

    object

    NEW 報告的時間 2 聚合結果，僅 NEW 返回。

    AvgDisplayValue

    string

    時間 2 有效查詢分鐘桶平均值的展示字串，含單位。

    3s
    AvgRatioPercent

    number

    此 Pattern 的時間 2 平均值佔當前報告、當前維度篩選前各 Pattern 平均值之和的百分比，10 表示 10%。

    10
    AvgValue

    number

    時間 2 的有效查詢分鐘桶平均值，即總和除以有該 Pattern 查詢的分鐘桶數。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    3
    MaxDisplayValue

    string

    時間 2 單分鐘桶峰值的展示字串，含單位。

    9s
    MaxValue

    number

    時間 2 單分鐘桶的最大指標值。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    9
    SumDisplayValue

    string

    時間 2 總和的展示字串，含單位。

    180s
    SumRatioPercent

    number

    此 Pattern 的時間 2 總和佔當前報告、當前維度篩選前結果全集總和的百分比，10 表示 10%。

    10
    SumValue

    number

    時間 2 的有效查詢分鐘桶指標值總和。數值單位由 MetricCode 決定：QUERY_COUNT 為次，CPU_COST 為秒，SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 為 GB（按 1 GB = 1024³ 位元組換算）。

    180
    Pattern

    string

    參數化後的 SQL Pattern 文字。IncludePattern 為 false 時為空或不返回；文字不可用時可能返回包含雜湊標識的提示。

    SELECT * FROM orders WHERE order_id = ?
    QueryCount

    integer

    時間 2 的查詢執行次數，單位為次。在 CPU_COST、SHUFFLE_SIZE、PEAK_MEMORY、SCAN_SIZE 維度返回。

    120
    QueryCountDisplayValue

    string

    時間 2 查詢執行次數的展示字串，適用範圍與 QueryCount 一致。

    120次
    Rank

    integer

    當前篩選和排序結果中的全域序號，從 1 開始，跨頁連續編號。

    1
    RiskLevel

    string

    當前分析維度的變化等級。取值說明：

    • NEW：新增 Pattern，僅 NEW 報告返回。

    • SLIGHT：輕微變化，平均變化率為 (0%, 20%]。

    • MODERATE：中等變化，平均變化率為 (20%, 50%]。

    • HIGH：高變化，平均變化率為 (50%, 100%]。

    • SEVERE：嚴重變化，平均變化率大於 100%，或屬於零基線增長。

    說明

    變化等級僅表示指標增長幅度，不能單獨用於判斷故障原因。

    枚舉值：

    • SLIGHT :

      輕微變化。

    • NEW :

      新增。

    • MODERATE :

      中等變化。

    • SEVERE :

      嚴重變化。

    • HIGH :

      高變化。

    SEVERE
    SqlPatternHash

    string

    SQL Pattern 的雜湊標識，以字串返回。請按字串儲存和傳遞，避免轉換為數字造成精度遺失。

    1234567890123456789
    TotalQueryTime

    string

    時間 2 的總查詢耗時展示字串，單位為秒，僅 QUERY_COUNT 維度返回。

    60s
    TotalScanCost

    string

    時間 2 的總掃描耗時展示字串，單位為秒，僅 SCAN_SIZE 維度返回。

    12s
    MetricType

    string

    分析維度。取值說明：

    • QUERY_COUNT：查詢執行次數。

    • CPU_COST：CPU 消耗。

    • SHUFFLE_SIZE：Shuffle 資料量。

    • PEAK_MEMORY：峰值記憶體消耗。

    • SCAN_SIZE：掃描資料量。

    枚舉值：

    • PEAK_MEMORY :

      峰值記憶體消耗。

    • CPU_COST :

      CPU 消耗。

    • QUERY_COUNT :

      查詢執行次數。

    • SHUFFLE_SIZE :

      Shuffle 資料量。

    • SCAN_SIZE :

      掃描資料量。

    CPU_COST
    PageNumber

    integer

    當前返回的頁碼，從 1 開始。

    1
    PageSize

    integer

    本次查詢使用的每頁最大返回數量。

    50
    ReportId

    integer

    SQL Pattern 對比報告 ID。

    1001
    RequestId

    string

    請求 ID。

    9A1B2C3D-4E5F-6789-ABCD-0123456789AB
    TotalCount

    integer

    當前報告、分析維度及變化率篩選條件下的 Pattern 總數，不是當前頁條數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "Items": [
    {
      "AvgExecutionTime": "0.4s",
      "AvgPlanningTime": "0.1s",
      "AvgRt": "0.5s",
      "MaxExecutionTime": "1.8s",
      "MaxPlanningTime": "0.2s",
      "MaxRt": "2s",
      "MetricValues": {
        "key": {
          "Avg": {
            "ChangeRatePercent": 200,
            "Time1DisplayValue": "1s",
            "Time1RatioPercent": 10,
            "Time1Value": 1,
            "Time2DisplayValue": "3s",
            "Time2RatioPercent": 10,
            "Time2Value": 3
          },
          "Max": {
            "ChangeRatePercent": 200,
            "Time1DisplayValue": "3s",
            "Time1Value": 3,
            "Time2DisplayValue": "9s",
            "Time2Value": 9
          },
          "MetricCode": "CPU_COST",
          "MetricName": "OperatorCost",
          "Primary": true,
          "Sum": {
            "ChangeRatePercent": 200,
            "Time1DisplayValue": "60s",
            "Time1RatioPercent": 10,
            "Time1Value": 60,
            "Time2DisplayValue": "180s",
            "Time2RatioPercent": 10,
            "Time2Value": 180
          },
          "Time2": {
            "AvgDisplayValue": "3s",
            "AvgRatioPercent": 10,
            "AvgValue": 3,
            "MaxDisplayValue": "9s",
            "MaxValue": 9,
            "SumDisplayValue": "180s",
            "SumRatioPercent": 10,
            "SumValue": 180
          }
        }
      },
      "Pattern": "SELECT * FROM orders WHERE order_id = ?",
      "QueryCount": 120,
      "QueryCountDisplayValue": "120次",
      "Rank": 1,
      "RiskLevel": "SEVERE",
      "SqlPatternHash": "1234567890123456789",
      "TotalQueryTime": "60s",
      "TotalScanCost": "12s"
    }
  ],
  "MetricType": "CPU_COST",
  "PageNumber": 1,
  "PageSize": 50,
  "ReportId": 1001,
  "RequestId": "9A1B2C3D-4E5F-6789-ABCD-0123456789AB",
  "TotalCount": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

    變更歷史

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