This topic describes how to query the description of a search index, including the information of columns in the search index and configurations of the search index.

Operations

You can call the DescribeSearchIndex operation to query the description of a search index.

Use Tablestore SDKs

You can use the following Tablestore SDKs to query the description of a search index:

Parameters

Parameter Description
tableName The name of the table.
indexName The name of the search index.

Examples

private static DescribeSearchIndexResponse describeSearchIndex(SyncClient client) {
    DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
    request.setTableName(TABLE_NAME); request.setTableName(TABLE_NAME); // Set the name of the table.
    request.setIndexName(INDEX_NAME); // Set the name of the search index.
    DescribeSearchIndexResponse response = client.describeSearchIndex(request);
    System.out.println(response.jsonize()); // Display the details of the response.
    System.out.println(response.getSyncStat().getSyncPhase().name());// Display the synchronization status of data in the search index.
    return response;
}