根据 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 执行计划的结束时间。 | 2023-04-12T05:38:38Z |
| DbName | string | 是 | 数据库名称。 | test_db |
| SqlId | string | 是 | SQL ID。 | 8D6E84****0B8FB1823D199E2CA1**** |
| AcceptLanguage | string | 否 | 支持的语言。取值：
| zh-CN |
| DynamicSql | boolean | 否 | 是否为动态 SQL。 | false |
| PlanUnionHash | string | 否 | 执行计划的唯一标识。 | c4e9aaa797428df9a5a41828******** |
| ReturnBriefInfo | boolean | 否 | 是否返回简要的执行计划信息。 | true |
返回参数
示例
正常返回示例
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,
"TableScan": false,
"OutlineId": "3********",
"OutlineStatus": "已生效"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-15 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-08-21 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |