文档

DescribeOasSQLPlans - 查询 SQL 执行计划

更新时间:

根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。

调试

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

授权信息

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

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

t4louaeei****
StartTimestring

查询 SQL 执行计划的起始时间。

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

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

查询 SQL 执行计划的结束时间。
该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

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

数据库名称。

test_db
SqlIdstring

SQL ID。

8D6E84****0B8FB1823D199E2CA1****
AcceptLanguagestring

支持的语言。取值:

  • 中文:zh-CN
  • 英文:en-US
zh-CN
DynamicSqlboolean

是否为动态 SQL。

false

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

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

SQL 执行计划信息列表。

PlanHashstring

SQL 执行计划在诊断系统内部的标识。

1758****24913166****
Plansobject []

执行计划列表。

Uidstring

Plan 的唯一标识。

AAAAAAAAAAI****AAFoT2QAF--7W****
PlanIdlong

计划 ID。

590****
FirstLoadTimestring

Plan 首次被加载的时间。

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

Plan 类型:LOCAL、REMOTE、DIST。

LOCAL
PlanHashstring

SQL 执行计划在诊断系统内部的标识。

-86290582****886880
PlanSizelong

计划大小。

10****
SchemaVersionlong

Schema 版本。

16838****3550464
MergedVersionlong

合并版本。

513
ObServerIdlong

server ID。

2
ObDbIdlong

数据库 ID。

11006****828
ServerIdlong

后端服务器实例 ID。

2
FirstLoadTimeUslong

首次加载时间。

1684****03289441
HitDiagnosisboolean

是否命中诊断。

false
OutlineDatastring

SQL 执行计划的 outline_data 字段。

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

Outline ID。

-1
CollectTimeUslong

收集时间。

1684368****00000
Serverstring

SQL 执行所在的 Server。

i-bp1db1a9us038****jio
HitPercentagedouble

命中率。

100.0
Executionslong

期间的总执行次数。

1
ExecPsdouble

期间的平均每秒执行次数。

0.31
AvgDiskReadsdouble

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

0.0
AvgDiskWritesdouble

期间内的平均物理写入次数。

0.0
AvgBufferGetsdouble

计划在期间内的平均缓存读次数。

30137.03
AvgApplicationWaitTimedouble

期间内的平均 Application 事件等待时间(毫秒)。

0.0
AvgConcurrencyWaitTimedouble

期间内的平均 Concurrency 事件等待时间(毫秒)。

0.0
AvgUserIoWaitTimedouble

期间内的平均 UserIo 事件等待时间(毫秒)。

0.0
AvgRowProcesseddouble

期间内的平均行处理等待时间(毫秒)。

1.0
AvgElapsedTimedouble

期间内的平均间隔等待时间(毫秒)。

1876.78
AvgCpuTimedouble

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

1875.34
LargeQueryPercentagedouble

长时间执行查询的完成百分比。

0.0
DelayedLargeQueryPercentagedouble

长时间执行查询的延迟百分比。

0.0
TimeoutPercentagedouble

超时百分比。

0.0
TableScanboolean

是否全表扫描。

false
PlanUnionHashstring

SQL 执行计划在诊断系统内部的唯一标识。

"52c7c53****53e61b3f7586b17****ad"
SqlIdstring

SQL ID。

46939C87ECA****95ED0FF64F44B****
MergedVersionlong

合并版本。

513
FirstLoadTimestring

首次加载时间

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

执行计划类型。

LOCAL
HitDiagnosisboolean

是否命中诊断。

false
HitPercentagedouble

命中率。

100.0
AvgCpuTimedouble

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

1875.34
PlanExplainobject

执行计划。

PlanJsonStringstring

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}]}"
Executionslong

执行次数。

1
PlanUnionHashstring

SQL 执行计划在诊断系统内部的唯一标识。

"52c7c53****53e61b3f7586b17****ad"
QuerySqlstring

查询语句。

说明
暂未使用,恒为空。
"select 1 from t"
Boundedboolean

是否绑定该执行计划。

false

示例

正常返回示例

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****"
        }
      ],
      "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
    }
  ]
}

错误码

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

变更历史

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