文档

DescribeOasTopSQLList - 查询 TopSQL 列表

更新时间:

查询诊断系统采集到的 SQL 执行性能数据列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oceanbase:DescribeOasTopSQLListRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

t4louaeei****
StartTimestring

查询 TOPSQL 参数的起始时间。 该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

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

查询 TOPSQL 参数的结束时间。

该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

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

数据库名称。

test_db
SearchKeyWordstring

关键字查询。

update
SearchParamstring

参数查询。

cputime
SearchRulestring

查询规则。

>
SearchValuestring

查询值。

0.01
SqlIdstring

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
NodeIpstring

节点 IP。

i-bp18l4****str4uk03
FilterConditionstring

所有字段通过 @ 来引用。可选字段请参考查询 SQL 的性能统计接口返回的所有列。

@avgCpuTime > 20 and @executions > 100
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh-CN
SqlTextLengthlong

返回 SQL 文本的最大长度。

65535
DynamicSqlboolean

是否动态 SQL。

说明
表示传入的 SQL ID 是否为动态 SQL 的 ID。
false
MergeDynamicSqlboolean

返回结果时,是否合并动态 SQL。

说明
表示输出结果时,是否聚合 in 查询的 SQL 的结果。
true

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject []

TopSQL 信息列表。

Executionslong

SQL 执行次数。

100
RpcCountdouble

SQL 总 RPC 次数。

100
RemotePlansdouble

SQL 远程执行次数。

100
MissPlansdouble

SQL 未命中计划缓存次数。

100
MaxElapsedTimedouble

SQL 最大响应时间。

10000
TotalWaitTimedouble

SQL 执行时,总等待时间(单位:毫秒),对应 v$sql_audit.total_wait_time_micro(单位:毫秒)。

100000
ExecPsdouble

SQL 执行频率。

0.31
MaxCpuTimedouble

最大 CPU 时间,单位毫秒。

13641.9
CpuPercentagedouble

CPU 占比。

100.0
ClientIpstring

客户端 IP。

i-bp1db****38uemejio
UserNamestring

用户名。

test_user
DbNamestring

数据库名称。

test_db
RetCode4012Countlong

期间内结果码 4012 的发生次数。

0
RetCode4013Countlong

期间内结果码 4013 的发生次数。

0
RetCode5001Countlong

期间内结果码 5001 的发生次数。

0
RetCode5024Countlong

期间内结果码 5024 的发生次数。

0
RetCode5167Countlong

期间内结果码 5167 的发生次数。

0
RetCode5217Countlong

期间内结果码 5217 的发生次数。

0
RetCode6002Countlong

期间内结果码 6002 的发生次数。

0
FailPercentagedouble

期间内的错误百分比。

0.0
SumWaitTimedouble

总等待时间(毫秒)。

9421.73
AvgWaitCountdouble

平均等待次数。

0.0
AvgRpcCountdouble

SQL 平均 RPC 次数。

8.0
LocalPlanPercentagedouble

SQL Local 计划比例。

0.0
RemotePlanPercentagedouble

SQL Remote 计划比例。

0.0
DistPlanPercentagedouble

SQLDistributed 计划比例。

100.0
SumElapsedTimedouble

SQL 总响应时间(毫秒)。

11452126.36
AvgNetTimedouble

期间内的平均网络传输时间(毫秒)。

0.0
AvgExecutorRpcCountdouble

SQL 远程执行次数, 对应 v$sl_audit.executor_rpc。

0.0
MissPlanPercentagedouble

SQL 未命中计划比例。

0.0
TableScanPercentagedouble

SQL 全表扫描比率。

0.0
StrongConsistencyPercentagedouble

SQL 强读比例。

100.0
WeakConsistencyPercentagedouble

SQL 弱读比例。

0.0
MaxAffectedRowsdouble

SQL 最大影响行数。

10000.0
MaxReturnRowsdouble

SQL 最大返回行数。

0.0
MaxWaitTimedouble

SQL 最大等待时间(毫秒)。

3.4
MaxApplicationWaitTimedouble

SQL 最大应用等待时间(毫秒)。

0.0
MaxConcurrencyWaitTimedouble

SQL 最大 IO 等待时间(毫秒)。

0.0
MaxUserIoWaitTimedouble

期间内的最大 UserIO 事件等待时间(毫秒)。

0.0
MaxDiskReadsdouble

最大磁盘读次数。

0.0
AvgExpectedWorkerCountdouble

预期并发数。

3
AvgUsedWorkerCountdouble

期间内 SQL 平均使用线程数。

3
SumLogicalReadsdouble

总逻辑读。

0.0
Serverstring

OBServer。

i-bp1db1****8uemejio
ServerIpstring

OBServerIp

i-bp1db1****8uemejio
ServerPortlong

OBServer Port。

389
SqlTextShortstring

SQL 文本(前 100 字符)。

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

SQL 类型。

select
SqlIdstring

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
Innerboolean

是否为内部 SQL。

false
WaitEventstring

最长等待事件。

none
AvgAffectedRowsdouble

平均影响行数。

9978.75
AvgReturnRowsdouble

平均返回行数。

0.0
AvgPartitionCountdouble

期间内平均访问分区数。

1.0
FailCountdouble

执行出错次数。

0
AvgWaitTimedouble

平均等待时间(毫秒)。

1442.49
AvgElapsedTimedouble

期间内的平均响应时间(毫秒)。

903.29
AvgCpuTimedouble

平均 CPU 时间(毫秒)。

1875.34
AvgNetWaitTimedouble

平均网络时间(毫秒)。

0.0
AvgQueueTimedouble

平均排队时间(毫秒)。

0.01
AvgDecodeTimedouble

平均解析时间(毫秒)。

0.0
AvgGetPlanTimedouble

获取执行计划的平均时间(毫秒)。

0.0
AvgExecuteTimedouble

SQL 平均执行时间(毫秒)。

1895.7
AvgApplicationWaitTimedouble

平均应用等待时间(毫秒)。

0.0
AvgConcurrencyWaitTimedouble

平均并发等待时间(毫秒)。

0.0
AvgUserIoWaitTimedouble

平均用户 IO 时间(毫秒)。

0.0
AvgScheduleTimedouble

平均调度时间(毫秒)。

0.0
AvgRowCacheHitdouble

平均 Row Cache 命中数。

0.0
AvgBloomFilterCacheHitdouble

平均 Bloom Filter Cache 命中数。

0.0
AvgBlockCacheHitdouble

平均 Block Cache 命中数。

0.0
AvgBlockIndexCacheHitdouble

平均 Block Index Cache 命中数。

0.0
AvgDiskReadsdouble

期间内的平均物理读次数。

0.0
RetryCountdouble

重试次数。

0
AvgMemstoreReadRowsdouble

平均 Memstore 读行数。

0.0
AvgSsstoreReadRowsdouble

平均 SSTable 读行数。

0.0
AvgLogicalReadsdouble

平均逻辑读。

0.0
DynamicSqlboolean

是否动态 SQL。

false
SqlListobject []

SQL 列表。

说明
入参 mergeDynamicSql = true 且有 in 查询时,会包含此参数。
Executionslong

SQL 执行次数。

100
RpcCountdouble

SQL 总 RPC 次数。

100
RemotePlansdouble

SQL 远程执行次数。

100
MissPlansdouble

SQL 未命中计划缓存次数。

100
MaxElapsedTimedouble

SQL 最大响应时间。

10000
TotalWaitTimedouble

SQL 执行时,总等待时间(单位:毫秒),对应 v$sql_audit.total_wait_time_micro(单位:毫秒)。

100000
ExecPsdouble

SQL 执行频率。

0.31
MaxCpuTimedouble

最大 CPU 时间。

13641.9
CpuPercentagedouble

CPU 占比。

100
ClientIpstring

客户端 IP。

127.*.*.*
UserNamestring

用户名。

test_user
DbNamestring

数据库名。

test
RetCode4012Countlong

错误码 4012 出现次数。

0
RetCode4013Countlong

错误码 4013 出现次数。

0
RetCode5001Countlong

错误码 5001 出现次数。

0
RetCode5024Countlong

错误码 5024 出现次数。

0
RetCode5167Countlong

错误码 5167 出现次数。

0
RetCode5217Countlong

错误码 5217 出现次数。

0
RetCode6002Countlong

错误码 6002 出现次数。

0
FailPercentagedouble

SQL 执行错误率。

0
SumWaitTimedouble

期间内的总等待时间(毫秒)。(waitTime, 对应 v$sql_audit.wait_time_micro)

9421.73
AvgWaitCountdouble

平均等待次数。

0
AvgRpcCountdouble

SQL 平均 RPC 次数。

8
LocalPlanPercentagedouble

SQL Local 计划比例。

0
RemotePlanPercentagedouble

SQL Remote 计划比例。

0
DistPlanPercentagedouble

SQLDistributed 计划比例。

100
SumElapsedTimedouble

SQL 总响应时间(毫秒)。

11452126.36
AvgNetTimedouble

SQL 平均网络 IO 时间(毫秒)。

0
AvgExecutorRpcCountdouble

SQL 远程执行次数, 对应 v$sl_audit.executor_rpc。

0
MissPlanPercentagedouble

SQL 未命中计划比例。

0
TableScanPercentagedouble

SQL 全表扫描比率。

0
StrongConsistencyPercentagedouble

SQL 强读比例。

100
WeakConsistencyPercentagedouble

SQL 弱读比例。

0
MaxAffectedRowsdouble

SQL 最大影响行数。

10000
MaxReturnRowsdouble

SQL 最大返回行数。

0
MaxWaitTimedouble

SQL 最大等待时间(毫秒)。

3.4
MaxApplicationWaitTimedouble

SQL 最大应用等待时间(毫秒)。

0
MaxConcurrencyWaitTimedouble

SQL 最大并发等待时间(毫秒)。

0
MaxUserIoWaitTimedouble

SQL 最大 IO 等待时间(毫秒)。

0
MaxDiskReadsdouble

最大磁盘读次数。

0
AvgExpectedWorkerCountdouble

预期并发数。

3
AvgUsedWorkerCountdouble

期间内 SQL 平均使用线程数。

3
SumLogicalReadsdouble

总逻辑读。

0
Serverstring

OBServer

i-bp1db1****8uemejio
ServerIpstring

OBServerIp

i-bp1db1****8uemejio
ServerPortlong

OBServer Port。

389
SqlTextShortstring

SQL 文本(前 100 字符)。

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

SQL 类型。

select
SqlIdstring

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
Innerboolean

是否是内部 SQL。

false
WaitEventstring

最长等待事件。

none
AvgAffectedRowsdouble

平均影响行数。

9978.75
AvgReturnRowsdouble

平均返回行数。

0
AvgPartitionCountdouble

平均访问分区数。

1
FailCountdouble

执行出错次数。

0
AvgWaitTimedouble

平均等待时间(毫秒)。

1442.49
AvgElapsedTimedouble

平均响应时间(毫秒)。

903.29
AvgCpuTimedouble

平均 CPU 时间(毫秒)。

1875.34
AvgNetWaitTimedouble

平均网络时间(毫秒)。

0
AvgQueueTimedouble

平均排队时间(毫秒)。

0.01
AvgDecodeTimedouble

平均解析时间(毫秒)。

0
AvgGetPlanTimedouble

获取执行计划的平均时间(毫秒)。

0
AvgExecuteTimedouble

SQL 平均执行时间(毫秒)。

1895.7
AvgApplicationWaitTimedouble

平均应用等待时间(毫秒)。

0
AvgConcurrencyWaitTimedouble

平均并发等待时间(毫秒)。

0
AvgUserIoWaitTimedouble

平均用户 IO 时间(毫秒)。

0
AvgScheduleTimedouble

平均调度时间(毫秒)。

0
AvgRowCacheHitdouble

平均 Row Cache 命中数。

0
AvgBloomFilterCacheHitdouble

平均 Bloom Filter Cache 命中数。

0
AvgBlockCacheHitdouble

平均 Block Cache 命中数。

0
AvgBlockIndexCacheHitdouble

平均 Block Index Cache 命中数。

0
AvgDiskReadsdouble

平均磁盘读次数。

0
RetryCountdouble

重试次数。

2
AvgMemstoreReadRowsdouble

平均 Memstore 读行数。

0
AvgSsstoreReadRowsdouble

平均 SSTable 读行数。

0
AvgLogicalReadsdouble

平均逻辑读。

0
AvgDbTimedouble

平均数据库时间(毫秒)。

100
SumDbTimedouble

总数据库时间(毫秒)。

100
LastFailCodelong

最后一次执行出错的错误码。

-4012
AvgDbTimedouble

平均数据库时间(毫秒)。

100
SumDbTimedouble

总数据库时间(毫秒)。

100

示例

正常返回示例

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
        }
      ],
      "LastFailCode": -4012,
      "AvgDbTime": 100,
      "SumDbTime": 100
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:DynamicSql
    新增入参:MergeDynamicSql
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)