DescribeOasSQLPlans - 查询 SQL 执行计划 - 云数据库 OceanBase （文档停止维护）

根据 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
    }
  ]
}

错误码

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

变更历史

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