全部產品
Search

搜尋本產品

    AnalyticDB：DescribeSqlPatternCompareReports

    文件中心

    AnalyticDB：DescribeSqlPatternCompareReports

    更新時間：Sep 17, 2026

    查詢 SQL Pattern 對比報告列表。

    介面說明

    查詢指定執行個體下當前阿里雲主帳號建立的 SQL Pattern 對比報告。RAM 使用者查詢所屬主帳號的報告。

    支援以下分頁方式：

    • 頁碼分頁（推薦）：使用 PageNumber、PageSize。

    • 令牌分頁：使用 MaxResults、NextToken。

    說明

    • 兩種分頁方式不可混用。頁碼分頁時，平台自動攜帶的 MaxResults 不生效。

    • 列表僅返回未過期的 PENDING、RUNNING 或 SUCCESS 報告。

    • 透過 DetailEnabled 判斷是否可查詢詳情，透過 CancelAvailable 判斷是否可取消。

    • 報告有效期為 7 天，並按執行個體和阿里雲主帳號隔離。

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    執行個體所在的地域 ID。

    cn-beijing
    DBClusterId

    string

    是

    AnalyticDB for MySQL 執行個體 ID。

    am-2ze1234567890****
    PageNumber

    integer

    否

    頁碼，從 1 開始。

    預設值：1。

    說明

    與 PageSize 配合使用。傳入該參數時，NextToken 必須為空。

    2
    PageSize

    integer

    否

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

    預設值：50。

    說明

    與 PageNumber 配合使用。傳入該參數時，NextToken 必須為空。

    50
    MaxResults

    integer

    否

    令牌分頁的每頁行數，取值範圍：1～100。

    預設值：50。

    說明

    • 使用 NextToken 翻頁時，該參數須保持不變。

    • 使用 PageNumber、PageSize 分頁時，該參數不生效。

    • 推薦使用 PageNumber、PageSize 分頁。

    50
    NextToken

    string

    否

    下一頁令牌。

    說明

    • 首次查詢時不傳，後續查詢時原樣傳入上一次返回的 NextToken。

    • 不得與 PageNumber 或 PageSize 同時使用。

    • 推薦使用 PageNumber、PageSize 分頁。

    djE6Mjo1MA
    Order

    string

    否

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

    • Field 表示排序欄位。取值說明：

      • CreatedAt：報告建立時間。

      • StartTime：時間 1 的開始時間。

      • CompareStartTime：時間 2 的開始時間。

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

      • Asc：升序排列。

      • Desc：降序排列。

    說明

    若不設定該參數，預設按照 CreatedAt 欄位降序排列。

    [{"Field":"CreatedAt","Type":"Desc"}]

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    報告列表的分頁查詢結果。

    Items

    array<object>

    當前頁的報告列表；無符合條件的報告時為空陣列。

    object

    單份 SQL Pattern 對比報告。

    CancelAvailable

    boolean

    是否可取消。PENDING 或 RUNNING 時為 true。

    false
    CompareEndTime

    string

    時間 2 的結束時間。UTC 格式為 yyyy-MM-ddTHH:mmZ。

    2026-09-08T01:00Z
    CompareStartTime

    string

    時間 2 的開始時間。UTC 格式為 yyyy-MM-ddTHH:mmZ。

    2026-09-08T00:00Z
    CreatedAt

    string

    報告建立時間。UTC 格式為 yyyy-MM-ddTHH:mmZ。

    2026-09-08T01:05Z
    DetailEnabled

    boolean

    是否可查詢詳情。SUCCESS 時為 true。

    true
    EndTime

    string

    時間 1 的結束時間。UTC 格式為 yyyy-MM-ddTHH:mmZ。

    2026-09-07T01:00Z
    ReportId

    integer

    SQL Pattern 對比報告 ID。

    1001
    ReportType

    string

    報告類型。取值說明：

    • NEW：新增 Pattern。

    • CHANGED：指標增長的 Pattern。

    枚舉值：

    • NEW :

      新增 SQL Pattern。

    • CHANGED :

      指標增長的 SQL Pattern。

    CHANGED
    ReportTypeName

    string

    報告類型名稱。

    變化 Pattern 對比報告
    RowNumber

    integer

    當前排序結果中的序號，從 1 開始。

    1
    StartTime

    string

    時間 1 的開始時間。UTC 格式為 yyyy-MM-ddTHH:mmZ。

    2026-09-07T00:00Z
    Status

    string

    報告狀態。取值說明：

    • PENDING：等待生成。

    • RUNNING：正在生成。

    • SUCCESS：生成成功。

    • FAILED：生成失敗。

    • CANCELED：已取消。

    • EXPIRED：已過期。

    說明

    當前列表僅返回 PENDING、RUNNING 或 SUCCESS。

    枚舉值：

    • SUCCESS :

      生成成功。

    • FAILED :

      生成失敗。

    • RUNNING :

      正在生成。

    • CANCELED :

      已取消。

    • EXPIRED :

      已過期。

    • PENDING :

      等待生成。

    SUCCESS
    MaxResults

    integer

    本次查詢使用的每頁行數。

    50
    NextToken

    string

    下一頁令牌；為空表示沒有下一頁。

    djE6Mjo1MA
    PageNumber

    integer

    本次查詢使用的頁碼，從 1 開始。

    2
    PageSize

    integer

    本次查詢使用的每頁行數。

    50
    RequestId

    string

    請求 ID。

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

    integer

    符合條件的報告總數。

    51

    樣本

    正常返回樣本

    JSON格式

    {
  "Items": [
    {
      "CancelAvailable": false,
      "CompareEndTime": "2026-09-08T01:00Z",
      "CompareStartTime": "2026-09-08T00:00Z",
      "CreatedAt": "2026-09-08T01:05Z",
      "DetailEnabled": true,
      "EndTime": "2026-09-07T01:00Z",
      "ReportId": 1001,
      "ReportType": "CHANGED",
      "ReportTypeName": "变化 Pattern 对比报告",
      "RowNumber": 1,
      "StartTime": "2026-09-07T00:00Z",
      "Status": "SUCCESS"
    }
  ],
  "MaxResults": 50,
  "NextToken": "djE6Mjo1MA",
  "PageNumber": 2,
  "PageSize": 50,
  "RequestId": "9A1B2C3D-4E5F-6789-ABCD-0123456789AB",
  "TotalCount": 51
}

    錯誤碼

    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.

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

    變更歷史

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