You can call this operation to query detailed information of indexes created for a specified table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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

Specifies 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 in Data Management (DMS) Enterprise.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

IndexList

The detailed information of indexes.

Index

The detailed information of an 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 was successful.

Examples

Sample requests


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 format

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

Error codes

For a list of error codes, visit the API Error Center.