You can call this operation to return information about table indexes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListIndexes

The operation that you want to perform. Set the value to ListIndexes.

Logic Boolean Yes false

Indicates whether the table is a logical table.

TableId String Yes 1

The ID of the table.

Tid Long Yes 0

The ID of the tenant.

Note The tenant ID is taken from the tenant ID displayed when you move the pointer on your profile picture. For more information, see View tenant information .

Response parameters

Parameter Type Sample response Description
ErrorCode String UnknownError

The error codes.

ErrorMessage String UnknownError

The error message of the failure.

IndexList Array of Index

The index details list.

Index
IndexComment String test

The description of the index.

IndexId String 1

The ID of the index.

IndexName String idx_test

The name of the index.

IndexType String Primary

The type of the index. Valid values:

  • Primary
  • Unique
  • Normal
  • FullText
  • Spatial
TableId String 1

The ID of the table.

RequestId String 1F4DE2F1-5B47-462A-A973-E02EB7AF386B

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample request


     http(s)://[Endpoint]/? Action=ListIndexes &Logic=false &TableId=1 &Tid=0 &<common request parameters> 
   

Sample success responses

XML format


     <RequestId>1F4DE2F1-5B47-462A-A973-E02EB7AF386B</RequestId> <IndexList> <Index> <IndexComment/> <IndexType>Primary</IndexType> <IndexName>PRIMARY</IndexName> <IndexId>49331416</IndexId> <TableId>18396274</TableId> </Index> </IndexList> <Success>true</Success> 
   

JSON


     { "RequestId": "1F4DE2F1-5B47-462A-A973-E02EB7AF386B", "IndexList": { "Index": [ { "IndexComment": "", "IndexType": "Primary", "IndexName": "PRIMARY", "IndexId": 49331416, "TableId": 18396274 } ] }, "Success": true } 
   

Error codes

For more information about error codes, see error center.