查询 SQL 的优化建议包括两种：索引创建的建议、执行计划绑定的建议。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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
}
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-07-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |