全部產品
Search

搜尋本產品

    Database Autonomy Service：GetPfsSqlSample - 擷取SQL樣本資料

    文件中心

    Database Autonomy Service：GetPfsSqlSample - 擷取SQL樣本資料

    更新時間：Apr 21, 2026

    調用GetPfsSqlSample介面，擷取效能洞察（新版）功能的SQL樣本資料。

    介面說明

    使用該介面需滿足以下前提條件：

    • 使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。

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

    • 目標資料庫執行個體為 RDS MySQL 或 PolarDB MySQL 版。

    • 目標資料庫執行個體已開啟效能洞察（新版），詳情請參見效能洞察（新版）。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hdm:GetPfsSqlSample

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    執行個體 ID。

    說明

    僅支援 RDS MySQL 和 PolarDB MySQL 版資料庫執行個體。

    rm-2ze1jdv45i7l6****
    NodeId

    string

    否

    節點 ID。

    說明

    對於 RDS MySQL 叢集系列或 PolarDB MySQL 版資料庫執行個體，需要提供節點 ID。

    r-x****-db-0
    SqlId

    string

    否

    SQL ID。

    651b56fe9418d48edb8fdf0980ec****
    StartTime

    integer

    是

    查詢開始時間，格式為 unix 時間戳記，單位為毫秒。

    1676511134614
    EndTime

    integer

    是

    查詢結束時間，格式為 unix 時間戳記，單位為毫秒。

    說明

    查詢結束時間需晚於查詢開始時間，最多可查看最近一個月內任意七天的資料。

    1678074351197

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料。

    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    RequestId

    string

    請求 ID。

    9CB97BC4-6479-55D0-B9D0-EA925AFE****
    Code

    integer

    返回狀態代碼。

    200
    Success

    boolean

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true
    Data

    array<object>

    返回的 SQL 樣本資料。

    object

    返回資料。

    UserId

    string

    使用者識別碼。

    196278346919****
    InstanceId

    string

    執行個體 ID。

    rm-2ze1jdv45i7l6****
    NodeId

    string

    節點 ID。

    說明

    RDS MySQL 叢集系列或 PolarDB MySQL 版資料庫執行個體才會返回該資料。

    r-x****-db-0
    LogicId

    string

    邏輯庫 ID。

    xxxxx
    Timestamp

    integer

    執行 SQL 的時間，格式為 Unix 時間戳記，單位為毫秒。

    1660100753556
    SqlId

    string

    SQL ID。

    651b56fe9418d48edb8fdf0980ec****
    Sql

    string

    SQL 樣本。

    select * from xxxx where ****
    ThreadId

    integer

    線程 ID。

    81751940
    EventId

    integer

    事件 ID。

    63735293
    EndEventId

    integer

    該參數在事件開始時預設為 NULL，在事件結束時更新為線程當前事件編號。

    0
    EventName

    string

    事件名稱。

    statement/sql/select
    Latency

    number

    執行耗時，單位為毫秒。

    0.199
    LockLatency

    number

    鎖等待時間，單位為毫秒。

    0.09
    Errors

    integer

    SQL 陳述式錯誤數。

    0
    Warnings

    integer

    SQL 陳述式警告數。

    0
    RowsAffected

    integer

    影響行數。

    0
    RowsSent

    integer

    返回的 SQL 陳述式的當前行數。

    0
    RowsExamined

    integer

    掃描行數。

    2048576
    CreateTmpDiskTables

    integer

    執行語句時建立的磁碟上內部暫存資料表的數量。

    0
    CreateTmpTables

    integer

    執行語句時建立的內部暫存資料表的數量。

    0
    SelectFullJoin

    integer

    不使用索引而執行表掃描的串連數。

    重要 該參數是用來統計聯集查詢過程中沒有利用索引的情況，如果該參數值不為 0，請仔細檢查表的索引。

    0
    SelectFullRangeJoin

    integer

    在參考資料表上使用範圍搜尋的串連數。

    0
    SelectRange

    integer

    在第一個表中使用範圍的串連數量。

    0
    SelectRangeCheck

    integer

    在每一行資料後對索引值進行檢查，統計不帶索引值的串連的數量。

    重要 該參數是用來統計聯集查詢過程中沒有利用索引的情況，如果該參數值不為 0，請仔細檢查表的索引。

    0
    SelectScan

    integer

    掃描數量。

    0
    SortMergePasses

    integer

    排序演算法必須執行的合并次數。

    0
    SortRange

    integer

    使用範圍進行排序的次數。

    0
    SortRows

    integer

    排序行數。

    0
    SortScan

    integer

    掃描排序次數。

    1
    NoIndexUsed

    integer

    語句在不使用索引的情況下是否執行了表掃描：

    • 1：是。

    • 0：否。

    1
    NoGoodIndexUsed

    integer

    伺服器是否尋找不到可用於該語句的索引：

    • 1：是。

    • 0：否。

    1
    Db

    string

    資料庫名稱。

    testDB

    樣本

    正常返回樣本

    JSON格式

    {
  "Message": "Successful",
  "RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "UserId": "196278346919****",
      "InstanceId": "rm-2ze1jdv45i7l6****",
      "NodeId": "r-x****-db-0",
      "LogicId": "xxxxx",
      "Timestamp": 1660100753556,
      "SqlId": "651b56fe9418d48edb8fdf0980ec****",
      "Sql": "select * from xxxx where ****",
      "ThreadId": 81751940,
      "EventId": 63735293,
      "EndEventId": 0,
      "EventName": "statement/sql/select",
      "Latency": 0.199,
      "LockLatency": 0.09,
      "Errors": 0,
      "Warnings": 0,
      "RowsAffected": 0,
      "RowsSent": 0,
      "RowsExamined": 2048576,
      "CreateTmpDiskTables": 0,
      "CreateTmpTables": 0,
      "SelectFullJoin": 0,
      "SelectFullRangeJoin": 0,
      "SelectRange": 0,
      "SelectRangeCheck": 0,
      "SelectScan": 0,
      "SortMergePasses": 0,
      "SortRange": 0,
      "SortRows": 0,
      "SortScan": 1,
      "NoIndexUsed": 1,
      "NoGoodIndexUsed": 1,
      "Db": "testDB"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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