All Products
Search
Document Center

Data Management:ListIndexes

Last Updated:Mar 14, 2024

Queries the indexes of a table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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
TableIdstringYes

The ID of the table.

1
LogicbooleanYes

Specifies whether the table is a logical table.

false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
IndexListobject []

The details of indexes.

IndexNamestring

The name of the index.

idx_test
IndexTypestring

The type of the index. Valid values:

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

The ID of the table.

1
IndexIdstring

The ID of the index.

1
IndexCommentstring

The description of the index.

test
Successboolean

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 timeSummary of changesOperation
No change history