DescribeAdbMySqlIndexes - 查看表索引信息_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

用于查看表索引信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeAdbMySqlIndexes	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看集群的地域 ID。	cn-hangzhou
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看数仓版集群的集群 ID。	am-uf6wjk5xxxxxxxxxx
Schema	string	否	数据库名称。	tpch_oss
TableName	string	否	目标表名。说明若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。	orders

返回参数

名称	类型	描述	示例值
	object
Message	string	调用结果的信息。取值说明：请求正常，返回 Success。请求异常，返回具体异常信息。	Success
RequestId	string	请求 ID，阿里云为该请求生成的标识符。	F0983B43-B2EC-536A-8791-142B5CF1E9B6
Success	boolean	调用是否成功，取值说明： true：成功。 false：失败。	true
Schema	string	数据库名。说明如填写，后续迁移或同步操作，只会针对该数据库操作。	adb_demo
TableName	string	表名称。	test
IndexCount	integer	索引个数（索引缺失表目前所拥有的索引个数）筛选条件。输入格式为`运算符+分割服“”+索引个数`，例如`>=100`。	10
Indexes	array<object>	索引列表。
Column	object
Type	string	索引类型。	normal
Name	string	索引名。	ttl
Column	string	列名称。	preclcu

示例

正常返回示例

JSON格式

{
  "Message": "Success",
  "RequestId": "F0983B43-B2EC-536A-8791-142B5CF1E9B6",
  "Success": true,
  "Schema": "adb_demo",
  "TableName": "test",
  "IndexCount": 10,
  "Indexes": [
    {
      "Type": "normal",
      "Name": "ttl",
      "Column": "preclcu"
    }
  ]
}

错误码

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