调用ListIndexes获取表的索引信息_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

调用ListIndexes返回表索引信息。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	0
TableId	string	是	表 ID。	1
Logic	boolean	是	是否逻辑表。	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1F4DE2F1-5B47-462A-A973-E02EB7AF386B
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
IndexList	array<object>	索引详情列表。
	object
IndexName	string	索引名称	idx_test
IndexType	string	索引类型，取值如下： Primary Unique Normal FullText Spatial	Primary
TableId	string	表 ID	1
IndexId	string	索引 ID	1
IndexComment	string	索引描述	test
Success	boolean	请求是否成功。	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
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史