全部產品
Search

搜尋本產品

    ：GetQueryOptimizeDataStats - 擷取查詢治理模板資料

    文件中心

    ：GetQueryOptimizeDataStats - 擷取查詢治理模板資料

    更新時間：Dec 19, 2025

    調用GetQueryOptimizeDataStats介面，擷取查詢治理模板資料。

    介面說明

    • 在使用阿里雲 SDK 時，需要保證 aliyun-sdk-core 的版本大於 2.1.8，建議使用最新版本。

    • 使用 DAS 的 SDK 的版本為 2.1.8 或以上。

    • 在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。

    • 本介面適用的資料庫引擎為：

      • RDS MySQL

      • PolarDB MySQL 版

      • RDS PostgreSQL

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hdm:GetQueryOptimizeDataStats

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Engine

    string

    是

    資料庫引擎，取值：

    • MySQL

    • PolarDBMySQL

    • PostgreSQL

    MySQL
    InstanceIds

    string

    否

    執行個體 ID，多個執行個體 ID 用逗號分隔。

    rm-2ze8g2am97624****
    TagNames

    string

    否

    備用參數。

    None
    Keywords

    string

    否

    SQL 文本關鍵詞，多個關鍵詞以空格分隔。

    select update
    LogicalOperator

    string

    否

    多個 SQL 文本關鍵詞的邏輯關係。

    • or：或。

    • and：與。

    or
    Rules

    string

    否

    需要過濾的規則，多個規則以逗號分隔。具體資訊請參見查詢治理。

    DAS_NOT_IMPORTANT
    DbNames

    string

    否

    需要查詢的資料庫名。

    testdb01
    Time

    string

    是

    查詢資料的日期，格式為 Unix 時間戳記，單位為毫秒。

    1642953600000
    PageSize

    string

    否

    分頁查詢每頁最大記錄數，預設為 10。

    10
    PageNo

    string

    否

    分頁查詢的頁碼，從 1 開始，預設為 1。

    1
    OrderBy

    string

    否

    排序欄位，預設為 count。

    • count：執行次數。

    • maxQueryTime：最大執行時間。

    • avgQueryTime：平均執行時間。

    • maxLockTime：最大鎖等待時間。

    • avgLockTime：平均鎖等待時間。

    • maxRowsExamined：最大掃描行數。

    • avgRowsExamined：平均掃描行數。

    • maxRowsSent：最大返回行數。

    • avgRowsSent：平均返回行數。

    count
    Asc

    string

    否

    是否升序排序，預設為 true。

    • true：是。

    • false：否。

    true
    OnlyOptimizedSql

    string

    否

    是否只查詢待最佳化的 SQL，預設為 false。

    • true：是。

    • false：否。

    false
    SqlIds

    string

    否

    SQL 模板 ID，您可調用 GetQueryOptimizeExecErrorStats 介面查詢 SQL 模板 ID。

    2e8147b5ca2dfc640dfd5e43d96a****
    Region

    string

    否

    執行個體所屬地區，取值：

    • cn-china：中國內地。

    • cn-hongkong：中國香港。

    • ap-southeast-1：新加坡。

    此參數只有在請求參數 InstanceIds 為空白時有效。如果請求參數 InstanceIds 為空白時，按照 Region 參數設定的地區擷取資料，系統預設執行個體所屬地區為cn-china；如果請求參數 InstanceIds 不為空白時，即使設定了 Region 參數，也以 InstanceIds 所傳入的第一個執行個體所在地區為準擷取資料。

    說明

    在中國內地各地區建立的執行個體，傳入此參數時，都為cn-china。

    cn-china
    User

    string

    否

    需要查詢的資料庫帳號。

    testUser

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    返回的狀態代碼。

    200
    Message

    string

    請求返回訊息。

    Successful
    Data

    object

    詳細資料列表。

    Total

    integer

    總資料量。

    10
    PageNo

    integer

    備用參數。

    None
    PageSize

    integer

    備用參數。

    None
    Extra

    string

    備用參數。

    None
    List

    array<object>

    模板資料列表。

    array<object>

    模板資料列表。

    InstanceId

    string

    執行個體 ID。

    rm-2ze8g2am97624****
    Dbname

    string

    SQL 所屬資料庫名。

    testdb01
    SqlId

    string

    SQL 模板 ID。

    2e8147b5ca2dfc640dfd5e43d96a****
    SqlType

    string

    SQL 類別。

    INSERT
    Psql

    string

    SQL 模板。

    select 1
    SqlSample

    string

    SQL 模板下執行最慢的 SQL 樣本。

    select 2
    Count

    integer

    SQL 執行次數。

    100
    MaxQueryTime

    number

    最大查詢時間，單位為秒。

    1.1
    AvgQueryTime

    number

    平均查詢時間，單位為秒。

    1.1
    MaxLockTime

    number

    最大鎖等待時間，單位為秒。

    0.1
    AvgLockTime

    number

    平均鎖等待時間，單位為秒。

    0.1
    MaxRowsExamined

    integer

    最大掃描行數。

    100000
    AvgRowsExamined

    number

    平均掃描行數。

    100.1
    MaxRowsSent

    integer

    最大返回行數。

    10000
    AvgRowsSent

    number

    平均返回行數。

    100.1
    MaxRowsAffected

    integer

    最大影響行數。

    說明

    取值為-1 說明暫未採集到該欄位。

    10000
    AvgRowsAffected

    number

    平均影響行數。

    說明

    取值為-1 說明暫未採集到該欄位。

    100.1
    RuleList

    array<object>

    規則列表。

    object

    Name

    string

    規則名，具體資訊請參見查詢治理。

    DAS_NOT_IMPORTANT
    Type

    string

    規則類別：

    • Predefined：系統預定義。

    • UserDefined：使用者自訂。

    Predefined
    User

    string

    資料庫帳號。

    testUser
    RequestId

    string

    請求 ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    string

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 10,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "Dbname": "testdb01",
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "SqlType": "INSERT",
        "Psql": "select 1",
        "SqlSample": "select 2",
        "Count": 100,
        "MaxQueryTime": 1.1,
        "AvgQueryTime": 1.1,
        "MaxLockTime": 0.1,
        "AvgLockTime": 0.1,
        "MaxRowsExamined": 100000,
        "AvgRowsExamined": 100.1,
        "MaxRowsSent": 10000,
        "AvgRowsSent": 100.1,
        "MaxRowsAffected": 10000,
        "AvgRowsAffected": 100.1,
        "RuleList": [
          {
            "Name": "DAS_NOT_IMPORTANT",
            "Type": "Predefined"
          }
        ],
        "User": "testUser"
      }
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The request parameters are invalid. 請求參數錯誤
    403 NoPermission You are not authorized to do this action. 沒有許可權執行該操作

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

    變更歷史

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