文档

ListIndexes - 获取表的索引信息

调用ListIndexes返回表索引信息。

接口说明

仅管控模式为安全协同的数据库实例可调用此 API。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListIndexesList
  • 全部资源
    *

请求参数

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

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
0
TableIdstring

表 ID。

1
Logicboolean

是否逻辑表。

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1F4DE2F1-5B47-462A-A973-E02EB7AF386B
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
IndexListobject []

索引详情列表。

IndexNamestring

索引名称

idx_test
IndexTypestring

索引类型,取值如下:

  • Primary
  • Unique
  • Normal
  • FullText
  • Spatial
Primary
TableIdstring

表 ID

1
IndexIdstring

索引 ID

1
IndexCommentstring

索引描述

test
Successboolean

请求是否成功。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "1F4DE2F1-5B47-462A-A973-E02EB7AF386B",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "IndexList": {
    "Index": [
      {
        "IndexName": "idx_test",
        "IndexType": "Primary",
        "TableId": "1",
        "IndexId": "1",
        "IndexComment": "test"
      }
    ]
  },
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈