幫助中心
首頁 ApsaraDB for OceanBase (Deprecated) 開發參考 API參考 API目錄 診斷管理 DescribeOasSQLPlans - 查詢 SQL 執行計畫

DescribeOasSQLPlans - 查詢 SQL 執行計畫

更新時間：
Copy as MD

根據 SQLID 查詢診斷系統儲存的 SQL 執行計畫資訊。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeOasSQLPlans

get

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
InstanceId

string

是

OceanBase 叢集 ID。

ob317v4uif****
TenantId

string

是

租戶 ID。

t4louaeei****
StartTime

string

是

查詢 SQL 執行計畫的起始時間。

該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。

2023-04-12T04:38:38Z
EndTime

string

是

查詢 SQL 執行計畫的結束時間。
該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。

2023-04-12T05:38:38Z
DbName

string

是

資料庫名稱。

test_db
SqlId

string

是

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
AcceptLanguage

string

否

支援的語言。取值：

  • 中文：zh-CN

  • 英文：en-US

zh-CN
DynamicSql

boolean

否

是否為動態 SQL。

false
PlanUnionHash

string

否

執行計畫的唯一標識。

c4e9aaa797428df9a5a41828********
ReturnBriefInfo

boolean

否

是否返回簡要的執行計畫資訊。

true
FormatSqlId

string

否

format sqlId

返回參數

名稱

類型

描述

樣本值

object

請求的返回結果。

RequestId

string

請求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Data

array<object>

SQL 執行計畫資訊列表。

array<object>

SQL 執行計畫資訊。

PlanHash

string

SQL 執行計畫在診斷系統內部的標識。

1758****24913166****
Plans

array<object>

執行計畫列表。

object

請求的返回結果。

Uid

string

Plan 的唯一標識。

AAAAAAAAAAI****AAFoT2QAF--7W****
PlanId

integer

計劃 ID。

590****
FirstLoadTime

string

Plan 首次被載入的時間。

2023-04-12T04:46:38Z
PlanType

string

Plan 類型：LOCAL、REMOTE、DIST。

LOCAL
PlanHash

string

SQL 執行計畫在診斷系統內部的標識。

-86290582****886880
PlanSize

integer

計劃大小。

10****
SchemaVersion

integer

Schema 版本。

16838****3550464
MergedVersion

integer

合并版本。

513
ObServerId

integer

server ID。

2
ObDbId

integer

資料庫 ID。

11006****828
ServerId

integer

後端伺服器執行個體 ID。

2
FirstLoadTimeUs

integer

首次載入時間。

1684****03289441
HitDiagnosis

boolean

是否命中診斷。

false
OutlineData

string

SQL 執行計畫的 outline_data 欄位。

/*+ BEGIN_OUTLINE_DATA INDEX(@\"SEL$1\
OutlineId

integer

Outline ID。

-1
CollectTimeUs

integer

收集時間。

1684368****00000
Server

string

SQL 執行所在的 Server。

i-bp1db1a9us038****jio
HitPercentage

number

命中率。

100.0
Executions

integer

期間的總執行次數。

1
ExecPs

number

期間的平均每秒執行次數。

0.31
AvgDiskReads

number

期間內的平均物理讀次數。

0.0
AvgDiskWrites

number

期間內的平均物理寫入次數。

0.0
AvgBufferGets

number

計劃在期間內的平均緩衝讀次數。

30137.03
AvgApplicationWaitTime

number

期間內的平均 Application 事件等待時間（毫秒）。

0.0
AvgConcurrencyWaitTime

number

期間內的平均 Concurrency 事件等待時間（毫秒）。

0.0
AvgUserIoWaitTime

number

期間內的平均 UserIo 事件等待時間（毫秒）。

0.0
AvgRowProcessed

number

期間內的平均行處理等待時間（毫秒）。

1.0
AvgElapsedTime

number

期間內的平均間隔等待時間（毫秒）。

1876.78
AvgCpuTime

number

期間內的平均 CPU 時間（毫秒）。

1875.34
LargeQueryPercentage

number

長時間執行查詢的完成百分比。

0.0
DelayedLargeQueryPercentage

number

長時間執行查詢的延遲百分比。

0.0
TimeoutPercentage

number

逾時百分比。

0.0
TableScan

boolean

是否全表掃描。

false
PlanUnionHash

string

SQL 執行計畫在診斷系統內部的唯一標識。

"52c7c53****53e61b3f7586b17****ad"
SqlId

string

SQL ID。

46939C87ECA****95ED0FF64F44B****
SqlText

string

MergedVersion

integer

合并版本。

513
FirstLoadTime

string

首次載入時間

2023-04-12T04:46:38Z
PlanType

string

執行計畫類型。

LOCAL
HitDiagnosis

boolean

是否命中診斷。

false
HitPercentage

number

命中率。

100.0
AvgCpuTime

number

期間內的平均 CPU 時間（毫秒）。

1875.34
PlanExplain

object

執行計畫。

PlanJsonString

string

SQL 執行計畫的 JSON 字串。

"PlanJsonString":"{\"RootOperations\":[{\"Children\":[{\"Children\":[{\"Cost\":2000,\"ObjectName\":\"TR\",\"Operator\":\"PHY_TABLE_SCAN\",\"Property\":\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\",\"Rows\":86},{\"Children\":[{\"Cost\":2000,\"ObjectName\":\"NA\",\"Operator\":\"PHY_TABLE_SCAN\",\"Property\":\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\",\"Rows\":18}],\"Cost\":2013,\"ObjectName\":\"NULL\",\"Operator\":\"PHY_SORT\",\"Property\":\"NULL\",\"Rows\":18}],\"Cost\":4024,\"ObjectName\":\"NULL\",\"Operator\":\"PHY_MERGE_JOIN\",\"Property\":\"NULL\",\"Rows\":26}],\"Cost\":4025,\"ObjectName\":\"NULL\",\"Operator\":\"PHY_SCALAR_AGGREGATE\",\"Property\":\"NULL\",\"Rows\":1}]}"
Executions

integer

執行次數。

1
PlanUnionHash

string

SQL 執行計畫在診斷系統內部的唯一標識。

"52c7c53****53e61b3f7586b17****ad"
QuerySql

string

查詢語句。

說明


暫未使用，恒為空白。

"select 1 from t"
Bounded

boolean

是否綁定該執行計畫。

false
TableScan

boolean

該計劃是否包含全表掃描

false
OutlineId

string

該計劃使用的 outline id

3********
OutlineStatus

string

該計劃使用 outline 時的狀態，“已生效” 表示該計劃的 outline_data 與 outline 的 outlIne_content 能完全符合上，“未知” 表示，無法判斷狀態。

已生效
ByFormatSqlId

boolean

是否為模糊綁定

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "PlanHash": "1758****24913166****",
      "Plans": [
        {
          "Uid": "AAAAAAAAAAI****AAFoT2QAF--7W****",
          "PlanId": 0,
          "FirstLoadTime": "2023-04-12T04:46:38Z",
          "PlanType": "LOCAL",
          "PlanHash": "-86290582****886880",
          "PlanSize": 0,
          "SchemaVersion": 0,
          "MergedVersion": 513,
          "ObServerId": 2,
          "ObDbId": 0,
          "ServerId": 2,
          "FirstLoadTimeUs": 0,
          "HitDiagnosis": false,
          "OutlineData": "/*+ BEGIN_OUTLINE_DATA INDEX(@\\\"SEL$1\\",
          "OutlineId": -1,
          "CollectTimeUs": 0,
          "Server": "i-bp1db1a9us038****jio",
          "HitPercentage": 100,
          "Executions": 1,
          "ExecPs": 0.31,
          "AvgDiskReads": 0,
          "AvgDiskWrites": 0,
          "AvgBufferGets": 30137.03,
          "AvgApplicationWaitTime": 0,
          "AvgConcurrencyWaitTime": 0,
          "AvgUserIoWaitTime": 0,
          "AvgRowProcessed": 1,
          "AvgElapsedTime": 1876.78,
          "AvgCpuTime": 1875.34,
          "LargeQueryPercentage": 0,
          "DelayedLargeQueryPercentage": 0,
          "TimeoutPercentage": 0,
          "TableScan": false,
          "PlanUnionHash": "\"52c7c53****53e61b3f7586b17****ad\"",
          "SqlId": "46939C87ECA****95ED0FF64F44B****",
          "SqlText": ""
        }
      ],
      "MergedVersion": 513,
      "FirstLoadTime": "2023-04-12T04:46:38Z",
      "PlanType": "LOCAL",
      "HitDiagnosis": false,
      "HitPercentage": 100,
      "AvgCpuTime": 1875.34,
      "PlanExplain": {
        "PlanJsonString": "\"PlanJsonString\":\"{\\\"RootOperations\\\":[{\\\"Children\\\":[{\\\"Children\\\":[{\\\"Cost\\\":2000,\\\"ObjectName\\\":\\\"TR\\\",\\\"Operator\\\":\\\"PHY_TABLE_SCAN\\\",\\\"Property\\\":\\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\",\\\"Rows\\\":86},{\\\"Children\\\":[{\\\"Cost\\\":2000,\\\"ObjectName\\\":\\\"NA\\\",\\\"Operator\\\":\\\"PHY_TABLE_SCAN\\\",\\\"Property\\\":\\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\",\\\"Rows\\\":18}],\\\"Cost\\\":2013,\\\"ObjectName\\\":\\\"NULL\\\",\\\"Operator\\\":\\\"PHY_SORT\\\",\\\"Property\\\":\\\"NULL\\\",\\\"Rows\\\":18}],\\\"Cost\\\":4024,\\\"ObjectName\\\":\\\"NULL\\\",\\\"Operator\\\":\\\"PHY_MERGE_JOIN\\\",\\\"Property\\\":\\\"NULL\\\",\\\"Rows\\\":26}],\\\"Cost\\\":4025,\\\"ObjectName\\\":\\\"NULL\\\",\\\"Operator\\\":\\\"PHY_SCALAR_AGGREGATE\\\",\\\"Property\\\":\\\"NULL\\\",\\\"Rows\\\":1}]}\""
      },
      "Executions": 1,
      "PlanUnionHash": "\"52c7c53****53e61b3f7586b17****ad\"",
      "QuerySql": "\"select 1 from t\"",
      "Bounded": false,
      "TableScan": false,
      "OutlineId": "3********",
      "OutlineStatus": "已生效",
      "ByFormatSqlId": true
    }
  ]
}

錯誤碼

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

變更歷史

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

上一篇：DescribeOasSQLDetails - 查詢 SQL 詳細資料下一篇：DescribeSQLSamples - 查詢慢 SQL 執行明細的採樣資料