DescribeOasTopSQLList - 查询 TopSQL 列表 - 云数据库 OceanBase （文档停止维护）

查询诊断系统采集到的 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": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。