幫助中心
首頁 ApsaraDB for OceanBase (Deprecated) 開發參考 API參考 API目錄 診斷管理 DescribeOasTopSQLList - 查詢 TopSQL 列表

DescribeOasTopSQLList - 查詢 TopSQL 列表

更新時間：
Copy as MD

查詢診斷系統採集到的 SQL 執行效能資料列表。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeOasTopSQLList

get

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
InstanceId

string

是

OceanBase 叢集 ID。

ob317v4uif****
TenantId

string

是

租戶 ID。

t4louaeei****
StartTime

string

是

查詢 TOPSQL 參數的起始時間。 該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。

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

string

是

查詢 TOPSQL 參數的結束時間。

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

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

string

否

資料庫名稱。

test_db
SearchKeyWord

string

否

關鍵字查詢。

update
SearchParam

string

否

參數查詢。

cputime
SearchRule

string

否

查詢規則。

>
SearchValue

string

否

查詢值。

0.01
SqlId

string

否

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
NodeIp

string

否

節點 IP。

i-bp18l4****str4uk03
FilterCondition

string

否

所有欄位通過 @ 來引用。可選欄位請參考 查詢 SQL 的效能統計 介面返回的所有列。

@avgCpuTime > 20 and @executions > 100
AcceptLanguage

string

否

返回資訊的語言類型：

  • zh：中文

  • en：英文

zh-CN
SqlTextLength

integer

否

返回 SQL 文本的最大長度。

65535
DynamicSql

boolean

否

是否動態 SQL。

說明


表示傳入的 SQL ID 是否為動態 SQL 的 ID。

false
MergeDynamicSql

boolean

否

返回結果時，是否合并動態 SQL。

說明


表示輸出結果時，是否彙總 in 查詢的 SQL 的結果。

true
CustomColumns

string

否

自訂欄位規則。所有欄位通過 @ 來引用，運算子支援 +、-、*、/ 等，首字母需要調整為小寫。可選欄位請參考 查詢 SQL 的效能統計 介面返回的所有列。

@failCount/@executions

返回參數

名稱

類型

描述

樣本值

object

請求的返回結果。

RequestId

string

請求 ID。

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

array<object>

TopSQL 資訊列表。

array<object>

TopSQL 資訊。

Executions

integer

SQL 執行次數。

100
RpcCount

number

SQL 總 RPC 次數。

100
RemotePlans

integer

SQL 遠程執行次數。

100
MissPlans

integer

SQL 未命中計畫快取次數。

100
MaxElapsedTime

number

SQL 最大回應時間。

10000
TotalWaitTime

number

SQL 執行時，總等待時間（單位：毫秒），對應 v$sql_audit.total_wait_time_micro（單位：毫秒）。

100000
ExecPs

number

SQL 執行頻率。

0.31
MaxCpuTime

number

最大 CPU 時間，單位毫秒。

13641.9
CpuPercentage

number

CPU 佔比。

100.0
ClientIp

string

用戶端 IP。

i-bp1db****38uemejio
UserName

string

使用者名稱。

test_user
DbName

string

資料庫名稱。

test_db
RetCode4012Count

integer

期間內結果碼 4012 的發生次數。

0
RetCode4013Count

integer

期間內結果碼 4013 的發生次數。

0
RetCode5001Count

integer

期間內結果碼 5001 的發生次數。

0
RetCode5024Count

integer

期間內結果碼 5024 的發生次數。

0
RetCode5167Count

integer

期間內結果碼 5167 的發生次數。

0
RetCode5217Count

integer

期間內結果碼 5217 的發生次數。

0
RetCode6002Count

integer

期間內結果碼 6002 的發生次數。

0
FailPercentage

number

期間內的錯誤百分比。

0.0
SumWaitTime

number

總等待時間（毫秒）。

9421.73
AvgWaitCount

number

平均等待次數。

0.0
AvgRpcCount

number

SQL 平均 RPC 次數。

8.0
LocalPlanPercentage

number

SQL Local 計劃比例。

0.0
RemotePlanPercentage

number

SQL Remote 計劃比例。

0.0
DistPlanPercentage

number

SQLDistributed 計劃比例。

100.0
SumElapsedTime

number

SQL 總回應時間（毫秒）。

11452126.36
AvgNetTime

number

期間內的平均網路傳輸時間（毫秒）。

0.0
AvgExecutorRpcCount

number

SQL 遠程執行次數， 對應 v$sl_audit.executor_rpc。

0.0
MissPlanPercentage

number

SQL 未命中計劃比例。

0.0
TableScanPercentage

number

SQL 全表掃描比率。

0.0
StrongConsistencyPercentage

number

SQL 強讀比例。

100.0
WeakConsistencyPercentage

number

SQL 弱讀比例。

0.0
MaxAffectedRows

number

SQL 最大影響行數。

10000.0
MaxReturnRows

number

SQL 最大返回行數。

0.0
MaxWaitTime

number

SQL 最大等待時間（毫秒）。

3.4
MaxApplicationWaitTime

number

SQL 最大應用等待時間（毫秒）。

0.0
MaxConcurrencyWaitTime

number

SQL 最大 IO 等待時間（毫秒）。

0.0
MaxUserIoWaitTime

number

期間內的最大 UserIO 事件等待時間（毫秒）。

0.0
MaxDiskReads

number

最大磁碟讀次數。

0.0
AvgExpectedWorkerCount

number

預期並發數。

3
AvgUsedWorkerCount

number

期間內 SQL 平均使用線程數。

3
SumLogicalReads

number

總邏輯讀。

0.0
Server

string

OBServer。

i-bp1db1****8uemejio
ServerIp

string

OBServerIp

i-bp1db1****8uemejio
ServerPort

integer

OBServer Port。

389
SqlTextShort

string

SQL 文本（前 100 字元）。

delete /*+ XXX PARALLEL(4) */ fro
SqlType

string

SQL 類型。

select

SqlId

string

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
Inner

boolean

是否為內部 SQL。

false
WaitEvent

string

最長等待事件。

none
AvgAffectedRows

number

平均影響行數。

9978.75
AvgReturnRows

number

平均返回行數。

0.0
AvgPartitionCount

number

期間內平均訪問分區數。

1.0
FailCount

integer

執行出錯次數。

0
AvgWaitTime

number

平均等待時間（毫秒）。

1442.49
AvgElapsedTime

number

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

903.29
AvgCpuTime

number

平均 CPU 時間（毫秒）。

1875.34
AvgNetWaitTime

number

平均網路時間（毫秒）。

0.0
AvgQueueTime

number

平均排隊時間（毫秒）。

0.01
AvgDecodeTime

number

平均解析時間（毫秒）。

0.0
AvgGetPlanTime

number

擷取執行計畫的平均時間（毫秒）。

0.0
AvgExecuteTime

number

SQL 平均執行時間（毫秒）。

1895.7
AvgApplicationWaitTime

number

平均應用等待時間（毫秒）。

0.0
AvgConcurrencyWaitTime

number

平均並發等待時間（毫秒）。

0.0
AvgUserIoWaitTime

number

平均使用者 IO 時間（毫秒）。

0.0
AvgScheduleTime

number

平均調度時間（毫秒）。

0.0
AvgRowCacheHit

number

平均 Row Cache 命中數。

0.0
AvgBloomFilterCacheHit

number

平均 Bloom Filter Cache 命中數。

0.0
AvgBlockCacheHit

number

平均 Block Cache 命中數。

0.0
AvgBlockIndexCacheHit

number

平均 Block Index Cache 命中數。

0.0
AvgDiskReads

number

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

0.0
RetryCount

integer

重試次數。

0
AvgMemstoreReadRows

number

平均 Memstore 讀行數。

0.0
AvgSsstoreReadRows

number

平均 SSTable 讀行數。

0.0
AvgLogicalReads

number

平均邏輯讀。

0.0
DynamicSql

boolean

是否動態 SQL。

false
SqlList

array<object>

SQL 列表。

說明


入參 mergeDynamicSql = true 且有 in 查詢時，會包含此參數。

object

請求的返回結果。

Executions

integer

SQL 執行次數。

100
RpcCount

number

SQL 總 RPC 次數。

100
RemotePlans

integer

SQL 遠程執行次數。

100
MissPlans

integer

SQL 未命中計畫快取次數。

100
MaxElapsedTime

number

SQL 最大回應時間。

10000
TotalWaitTime

number

SQL 執行時，總等待時間（單位：毫秒），對應 v$sql_audit.total_wait_time_micro（單位：毫秒）。

100000
ExecPs

number

SQL 執行頻率。

0.31
MaxCpuTime

number

最大 CPU 時間。

13641.9
CpuPercentage

number

CPU 佔比。

100
ClientIp

string

用戶端 IP。

127.*.*.*
UserName

string

使用者名稱。

test_user
DbName

string

資料庫名。

test
RetCode4012Count

integer

錯誤碼 4012 出現次數。

0
RetCode4013Count

integer

錯誤碼 4013 出現次數。

0
RetCode5001Count

integer

錯誤碼 5001 出現次數。

0
RetCode5024Count

integer

錯誤碼 5024 出現次數。

0
RetCode5167Count

integer

錯誤碼 5167 出現次數。

0
RetCode5217Count

integer

錯誤碼 5217 出現次數。

0
RetCode6002Count

integer

錯誤碼 6002 出現次數。

0
FailPercentage

number

SQL 執行錯誤率。

0
SumWaitTime

number

期間內的總等待時間（毫秒）。（waitTime, 對應 v$sql_audit.wait_time_micro）

9421.73
AvgWaitCount

number

平均等待次數。

0
AvgRpcCount

number

SQL 平均 RPC 次數。

8
LocalPlanPercentage

number

SQL Local 計劃比例。

0
RemotePlanPercentage

number

SQL Remote 計劃比例。

0
DistPlanPercentage

number

SQLDistributed 計劃比例。

100
SumElapsedTime

number

SQL 總回應時間（毫秒）。

11452126.36
AvgNetTime

number

SQL 平均網路 IO 時間（毫秒）。

0
AvgExecutorRpcCount

number

SQL 遠程執行次數， 對應 v$sl_audit.executor_rpc。

0
MissPlanPercentage

number

SQL 未命中計劃比例。

0
TableScanPercentage

number

SQL 全表掃描比率。

0
StrongConsistencyPercentage

number

SQL 強讀比例。

100
WeakConsistencyPercentage

number

SQL 弱讀比例。

0
MaxAffectedRows

number

SQL 最大影響行數。

10000
MaxReturnRows

number

SQL 最大返回行數。

0
MaxWaitTime

number

SQL 最大等待時間（毫秒）。

3.4
MaxApplicationWaitTime

number

SQL 最大應用等待時間（毫秒）。

0
MaxConcurrencyWaitTime

number

SQL 最大並發等待時間（毫秒）。

0
MaxUserIoWaitTime

number

SQL 最大 IO 等待時間（毫秒）。

0
MaxDiskReads

number

最大磁碟讀次數。

0
AvgExpectedWorkerCount

number

預期並發數。

3
AvgUsedWorkerCount

number

期間內 SQL 平均使用線程數。

3
SumLogicalReads

number

總邏輯讀。

0
Server

string

OBServer

i-bp1db1****8uemejio
ServerIp

string

OBServerIp

i-bp1db1****8uemejio
ServerPort

integer

OBServer Port。

389
SqlTextShort

string

SQL 文本（前 100 字元）。

delete /*+ XXX PARALLEL(4) */ fro
SqlType

string

SQL 類型。

select
SqlId

string

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
Inner

boolean

是否是內部 SQL。

false
WaitEvent

string

最長等待事件。

none
AvgAffectedRows

number

平均影響行數。

9978.75
AvgReturnRows

number

平均返回行數。

0
AvgPartitionCount

number

平均訪問分區數。

1
FailCount

integer

執行出錯次數。

0
AvgWaitTime

number

平均等待時間（毫秒）。

1442.49
AvgElapsedTime

number

平均回應時間（毫秒）。

903.29
AvgCpuTime

number

平均 CPU 時間（毫秒）。

1875.34
AvgNetWaitTime

number

平均網路時間（毫秒）。

0
AvgQueueTime

number

平均排隊時間（毫秒）。

0.01
AvgDecodeTime

number

平均解析時間（毫秒）。

0
AvgGetPlanTime

number

擷取執行計畫的平均時間（毫秒）。

0
AvgExecuteTime

number

SQL 平均執行時間（毫秒）。

1895.7
AvgApplicationWaitTime

number

平均應用等待時間（毫秒）。

0
AvgConcurrencyWaitTime

number

平均並發等待時間（毫秒）。

0
AvgUserIoWaitTime

number

平均使用者 IO 時間（毫秒）。

0
AvgScheduleTime

number

平均調度時間（毫秒）。

0
AvgRowCacheHit

number

平均 Row Cache 命中數。

0
AvgBloomFilterCacheHit

number

平均 Bloom Filter Cache 命中數。

0
AvgBlockCacheHit

number

平均 Block Cache 命中數。

0
AvgBlockIndexCacheHit

number

平均 Block Index Cache 命中數。

0
AvgDiskReads

number

平均磁碟讀次數。

0
RetryCount

integer

重試次數。

2
AvgMemstoreReadRows

number

平均 Memstore 讀行數。

0
AvgSsstoreReadRows

number

平均 SSTable 讀行數。

0
AvgLogicalReads

number

平均邏輯讀。

0
AvgDbTime

number

平均資料庫時間（毫秒）。

100
SumDbTime

number

總資料庫時間（毫秒）。

100
FormatSqlId

string

FormatSqlId

LastFailCode

integer

最後一次執行出錯的錯誤碼。

-4012
AvgDbTime

number

平均資料庫時間（毫秒）。

100
SumDbTime

number

總資料庫時間（毫秒）。

100
CustomColumns

object

自訂欄。

Expression

string

自訂欄的運算式。

@failCount/@executions
Value

string

根據運算式計算的值。

0.0
ObDbId

integer

資料庫 ID。

11006111****4828
FormatSqlId

string

FormatSqlId

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "Executions": 100,
      "RpcCount": 100,
      "RemotePlans": 100,
      "MissPlans": 100,
      "MaxElapsedTime": 10000,
      "TotalWaitTime": 100000,
      "ExecPs": 0.31,
      "MaxCpuTime": 13641.9,
      "CpuPercentage": 100,
      "ClientIp": "i-bp1db****38uemejio",
      "UserName": "test_user",
      "DbName": "test_db",
      "RetCode4012Count": 0,
      "RetCode4013Count": 0,
      "RetCode5001Count": 0,
      "RetCode5024Count": 0,
      "RetCode5167Count": 0,
      "RetCode5217Count": 0,
      "RetCode6002Count": 0,
      "FailPercentage": 0,
      "SumWaitTime": 9421.73,
      "AvgWaitCount": 0,
      "AvgRpcCount": 8,
      "LocalPlanPercentage": 0,
      "RemotePlanPercentage": 0,
      "DistPlanPercentage": 100,
      "SumElapsedTime": 11452126.36,
      "AvgNetTime": 0,
      "AvgExecutorRpcCount": 0,
      "MissPlanPercentage": 0,
      "TableScanPercentage": 0,
      "StrongConsistencyPercentage": 100,
      "WeakConsistencyPercentage": 0,
      "MaxAffectedRows": 10000,
      "MaxReturnRows": 0,
      "MaxWaitTime": 3.4,
      "MaxApplicationWaitTime": 0,
      "MaxConcurrencyWaitTime": 0,
      "MaxUserIoWaitTime": 0,
      "MaxDiskReads": 0,
      "AvgExpectedWorkerCount": 3,
      "AvgUsedWorkerCount": 3,
      "SumLogicalReads": 0,
      "Server": "i-bp1db1****8uemejio",
      "ServerIp": "i-bp1db1****8uemejio",
      "ServerPort": 389,
      "SqlTextShort": "delete /*+ XXX PARALLEL(4) */ fro",
      "SqlType": "select ",
      "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
      "Inner": false,
      "WaitEvent": "none",
      "AvgAffectedRows": 9978.75,
      "AvgReturnRows": 0,
      "AvgPartitionCount": 1,
      "FailCount": 0,
      "AvgWaitTime": 1442.49,
      "AvgElapsedTime": 903.29,
      "AvgCpuTime": 1875.34,
      "AvgNetWaitTime": 0,
      "AvgQueueTime": 0.01,
      "AvgDecodeTime": 0,
      "AvgGetPlanTime": 0,
      "AvgExecuteTime": 1895.7,
      "AvgApplicationWaitTime": 0,
      "AvgConcurrencyWaitTime": 0,
      "AvgUserIoWaitTime": 0,
      "AvgScheduleTime": 0,
      "AvgRowCacheHit": 0,
      "AvgBloomFilterCacheHit": 0,
      "AvgBlockCacheHit": 0,
      "AvgBlockIndexCacheHit": 0,
      "AvgDiskReads": 0,
      "RetryCount": 0,
      "AvgMemstoreReadRows": 0,
      "AvgSsstoreReadRows": 0,
      "AvgLogicalReads": 0,
      "DynamicSql": false,
      "SqlList": [
        {
          "Executions": 100,
          "RpcCount": 100,
          "RemotePlans": 100,
          "MissPlans": 100,
          "MaxElapsedTime": 10000,
          "TotalWaitTime": 100000,
          "ExecPs": 0.31,
          "MaxCpuTime": 13641.9,
          "CpuPercentage": 100,
          "ClientIp": "127.*.*.*",
          "UserName": "test_user",
          "DbName": "test",
          "RetCode4012Count": 0,
          "RetCode4013Count": 0,
          "RetCode5001Count": 0,
          "RetCode5024Count": 0,
          "RetCode5167Count": 0,
          "RetCode5217Count": 0,
          "RetCode6002Count": 0,
          "FailPercentage": 0,
          "SumWaitTime": 9421.73,
          "AvgWaitCount": 0,
          "AvgRpcCount": 8,
          "LocalPlanPercentage": 0,
          "RemotePlanPercentage": 0,
          "DistPlanPercentage": 100,
          "SumElapsedTime": 11452126.36,
          "AvgNetTime": 0,
          "AvgExecutorRpcCount": 0,
          "MissPlanPercentage": 0,
          "TableScanPercentage": 0,
          "StrongConsistencyPercentage": 100,
          "WeakConsistencyPercentage": 0,
          "MaxAffectedRows": 10000,
          "MaxReturnRows": 0,
          "MaxWaitTime": 3.4,
          "MaxApplicationWaitTime": 0,
          "MaxConcurrencyWaitTime": 0,
          "MaxUserIoWaitTime": 0,
          "MaxDiskReads": 0,
          "AvgExpectedWorkerCount": 3,
          "AvgUsedWorkerCount": 3,
          "SumLogicalReads": 0,
          "Server": "i-bp1db1****8uemejio",
          "ServerIp": "i-bp1db1****8uemejio",
          "ServerPort": 389,
          "SqlTextShort": "delete /*+ XXX PARALLEL(4) */ fro",
          "SqlType": "select",
          "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
          "Inner": false,
          "WaitEvent": "none",
          "AvgAffectedRows": 9978.75,
          "AvgReturnRows": 0,
          "AvgPartitionCount": 1,
          "FailCount": 0,
          "AvgWaitTime": 1442.49,
          "AvgElapsedTime": 903.29,
          "AvgCpuTime": 1875.34,
          "AvgNetWaitTime": 0,
          "AvgQueueTime": 0.01,
          "AvgDecodeTime": 0,
          "AvgGetPlanTime": 0,
          "AvgExecuteTime": 1895.7,
          "AvgApplicationWaitTime": 0,
          "AvgConcurrencyWaitTime": 0,
          "AvgUserIoWaitTime": 0,
          "AvgScheduleTime": 0,
          "AvgRowCacheHit": 0,
          "AvgBloomFilterCacheHit": 0,
          "AvgBlockCacheHit": 0,
          "AvgBlockIndexCacheHit": 0,
          "AvgDiskReads": 0,
          "RetryCount": 2,
          "AvgMemstoreReadRows": 0,
          "AvgSsstoreReadRows": 0,
          "AvgLogicalReads": 0,
          "AvgDbTime": 100,
          "SumDbTime": 100,
          "FormatSqlId": ""
        }
      ],
      "LastFailCode": -4012,
      "AvgDbTime": 100,
      "SumDbTime": 100,
      "CustomColumns": {
        "Expression": "@failCount/@executions",
        "Value": "0.0"
      },
      "ObDbId": 0,
      "FormatSqlId": ""
    }
  ]
}

錯誤碼

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

變更歷史

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

上一篇：DescribeOasSQLHistoryList - 查詢 SQL 執行歷史下一篇：DescribeOasSlowSQLList - 查詢慢 SQL 列表