DescribeSQLTuningAdvices - 查詢 SQL 的最佳化建議
查詢 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
}
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。