DescribeRecommendIndex - 查询 SQL 索引推荐信息 - 云数据库 OceanBase （文档停止维护）

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oceanbase:DescribeRecommendIndex

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TenantId	string	是	租户 ID。	t2mr3oae0****
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
SQLId	string	是	可在 DescribeSlowSQLList/DescribeTopSQLList 接口的返回值中获取 SQLID。	8D6E84**0B8FB1823D199E2CA1**

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
RecommendIndex	object	推荐索引信息。
SuggestIndex	string	返回根据诊断系统计算后为 SQL 语句推荐的索引。如推荐的索引为主键，则返回 PRIMARY；如推荐用户创建的索引，则返回索引名。当前系统仅为 SQL 推荐一个索引，可通过 DescribeIndexes API 查看一个表的索引数据。	PRIMARY
TenantMode	string	返回租户模式。当前支持： Oracle：Oracle 模式。 MySQL: MySQL 模式。	mysql
TableList	string	表信息。返回 SQLID 对应 SQL 语句涉及到的数据表，如单表查询，则返回访问的单张数据表，如关联查询，则返回 SQL 语句访问的所有数据表，以竖线分隔，如 "Table1\|Table2"。	testtable

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "RecommendIndex": {
    "SuggestIndex": "PRIMARY",
    "TenantMode": "mysql",
    "TableList": "testtable"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
2014	InternalError	The request processing has failed due to some unknown error.

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

变更历史

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