查询 SQL 的优化建议包括两种：索引创建的建议、执行计划绑定的建议。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
oceanbase:DescribeSQLTuningAdvices |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
集群 id |
obsdf43**** |
| TenantId |
string |
是 |
租户 ID |
tsdc2s2**** |
| DbName |
string |
是 |
数据库名称 |
testdb |
| SqlId |
string |
是 |
SqlId |
123456 |
| StartTime |
string |
是 |
开始时间 |
2023-04-12T04:38:38Z |
| EndTime |
string |
是 |
结束时间 |
2023-04-12T05:38:38Z |
| AcceptLanguage |
string |
否 |
支持的语言。取值：
|
zh-CN |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
请求的返回结果 |
||
| RequestId |
string |
请求 ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Data |
array<object> |
SQL 执行计划信息列表。 |
|
|
array<object> |
SQL 执行计划信息。 |
||
| Type |
string |
优化类型 |
PLAN_BINDING/INDEX_CREATION |
| ColumnNames |
string |
索引列顺序 |
c1;c2;c3 |
| LocalityType |
string |
索引类型 |
Local/Global |
| Columns |
array<object> |
索引列列表 |
|
|
object |
索引列信息 |
||
| ColumnName |
string |
列名 |
xxxx |
| Ndv |
number |
NDV |
100 |
| MinValue |
string |
最小值 |
1 |
| MaxValue |
string |
最大值 |
100 |
| DbName |
string |
数据库名称 |
test_db |
| Table |
string |
表名 |
test_table |
| Plan |
object |
执行计划 |
|
| Executions |
integer |
期间的总执行次数。 |
2062 |
| AvgCpuTime |
number |
期间内的平均 CPU 时间（毫秒）。 |
100.36 |
| PlanHash |
string |
SQL 执行计划在诊断系统内部的标识。 |
-86290582****886880 |
| TimeoutPercentage |
number |
超时百分比。 |
0 |
| AvgConcurrencyWaitTime |
number |
期间内的平均 Concurrency 事件等待时间（毫秒）。 |
0 |
| FirstLoadTimeUs |
integer |
首次加载时间。 |
1672367130576163 |
| AvgDiskWrites |
number |
期间内的平均物理写入次数。 |
0 |
| AvgUserIoWaitTime |
number |
期间内的平均 UserIo 事件等待时间（毫秒）。 |
0 |
| PlanSize |
integer |
计划大小。 |
49216 |
| ServerSn |
string |
节点 ID。 |
i-bp1*****sw64dhb***** |
| OutlineData |
string |
SQL 执行计划的 outline_data 字段。 |
xxxxx |
| PlanType |
string |
Plan 类型：LOCAL、REMOTE、DIST。 |
LOCAL |
| ObDbId |
integer |
数据库 ID。 |
1108307720799259 |
| HitPercentage |
number |
命中率。 |
66.8 |
| AvgBufferGets |
number |
计划在期间内的平均缓存读次数。 |
0 |
| ExecPs |
number |
期间的平均每秒执行次数。 |
1.45 |
| DelayedLargeQueryPercentage |
number |
长时间执行查询的延迟百分比。 |
0 |
| TableScan |
boolean |
是否全表扫描。 |
false |
| LargeQueryPercentage |
number |
长时间执行查询的完成百分比。 |
0 |
| SchemaVersion |
integer |
Schema 版本。 |
1672367130529680 |
| PlanId |
integer |
计划 ID。 |
818 |
| FirstLoadTime |
string |
首次加载时间。 |
2022-12-30T02:25:30.576Z |
| AvgRowProcessed |
number |
期间内的平均行处理等待时间（毫秒）。 |
1 |
| MergedVersion |
integer |
合并版本。 |
3 |
| HitDiagnosis |
boolean |
是否命中诊断。 |
false |
| Uid |
string |
Plan 的唯一标识。 |
AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj |
| AvgApplicationWaitTime |
number |
期间内的平均 Application 事件等待时间（毫秒）。 |
0 |
| CollectTimeUs |
integer |
收集时间。 |
1672358400000000 |
| AvgElapsedTime |
number |
期间内的平均间隔等待时间（毫秒）。 |
713.62 |
| ObServerId |
integer |
server ID。 |
1 |
| OutlineId |
integer |
Outline ID。 |
1 |
| AvgDiskReads |
number |
期间内的平均物理读次数。 |
0 |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Data": [
{
"Type": "PLAN_BINDING/INDEX_CREATION",
"ColumnNames": "c1;c2;c3",
"LocalityType": "Local/Global",
"Columns": [
{
"ColumnName": "xxxx",
"Ndv": 100,
"MinValue": "1",
"MaxValue": "100"
}
],
"DbName": "test_db",
"Table": "test_table",
"Plan": {
"Executions": 2062,
"AvgCpuTime": 100.36,
"PlanHash": "-86290582****886880",
"TimeoutPercentage": 0,
"AvgConcurrencyWaitTime": 0,
"FirstLoadTimeUs": 1672367130576163,
"AvgDiskWrites": 0,
"AvgUserIoWaitTime": 0,
"PlanSize": 49216,
"ServerSn": "i-bp1*****sw64dhb*****",
"OutlineData": "xxxxx",
"PlanType": "LOCAL",
"ObDbId": 1108307720799259,
"HitPercentage": 66.8,
"AvgBufferGets": 0,
"ExecPs": 1.45,
"DelayedLargeQueryPercentage": 0,
"TableScan": false,
"LargeQueryPercentage": 0,
"SchemaVersion": 1672367130529680,
"PlanId": 818,
"FirstLoadTime": "2022-12-30T02:25:30.576Z",
"AvgRowProcessed": 1,
"MergedVersion": 3,
"HitDiagnosis": false,
"Uid": "AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj",
"AvgApplicationWaitTime": 0,
"CollectTimeUs": 1672358400000000,
"AvgElapsedTime": 713.62,
"ObServerId": 1,
"OutlineId": 1,
"AvgDiskReads": 0
}
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。