文档

DescribeRecommendIndex - 查询 SQL 索引推荐信息

更新时间:

根据 SQLID 查询诊断系统对 SQL 的索引推荐信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TenantIdstring

租户 ID。

t2mr3oae0****
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
SQLIdstring

可在 DescribeSlowSQLList/DescribeTopSQLList 接口的返回值中获取 SQLID。

8D6E84****0B8FB1823D199E2CA1****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
RecommendIndexobject

推荐索引信息。

SuggestIndexstring

返回根据诊断系统计算后为 SQL 语句推荐的索引。

  • 如推荐的索引为主键,则返回 PRIMARY;
  • 如推荐用户创建的索引,则返回索引名。
    当前系统仅为 SQL 推荐一个索引,可通过 DescribeIndexes API 查看一个表的索引数据。
PRIMARY
TenantModestring

返回租户模式。 当前支持:

  • Oracle:Oracle 模式。
  • MySQL: MySQL 模式。
mysql
TableListstring

表信息。
返回 SQLID 对应 SQL 语句涉及到的数据表,如单表查询,则返回访问的单张数据表,如关联查询,则返回 SQL 语句访问的所有数据表,以竖线分隔,如 "Table1|Table2"。

testtable

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)