通過ListIndexes API列出指定表的索引-Data Management-阿里雲

調用ListIndexes返回表索引資訊。

介面說明

僅管控模式為安全協同的資料庫執行個體可調用此 API。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListIndexes

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 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	object
Index	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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。