ListIndexes - Data Management - Alibaba Cloud Documentation Center

Queries the indexes of a table.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	0
TableId	string	Yes	The ID of the table.	1
Logic	boolean	Yes	Specifies whether the table is a logical table.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1F4DE2F1-5B47-462A-A973-E02EB7AF386B
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
IndexList	array<object>	The details of indexes.
Index	object
IndexName	string	The name of the index.	idx_test
IndexType	string	The type of the index. Valid values: Primary Unique Normal FullText Spatial	Primary
TableId	string	The ID of the table.	1
IndexId	string	The ID of the index.	1
IndexComment	string	The description of the index.	test
Success	boolean	Indicates whether the request is successful.	true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history