Query the description of a search index - Tablestore - Alibaba Cloud Documentation Center

Request syntax

message DescribeSearchIndexRequest {
    optional string table_name = 1;
    optional string index_name = 2;
    optional bool include_sync_stat = 3;
}

Parameter	Type	Required	Description
table_name	string	No	The name of the data table.
index_name	string	No	The name of the search index.
include_sync_stat	bool	No	Specifies whether to return the synchronization status. Default value: true.

Response syntax

message DescribeSearchIndexResponse {
    optional IndexSchema schema = 1;
    optional SyncStat sync_stat = 2;
    optional MeteringInfo metering_info = 3;
    optional string brother_index_name = 4;
    repeated QueryFlowWeight query_flow_weight = 5;
    optional int64 create_time = 6;
    optional int32 time_to_live = 7;  // unit is seconds
}

Parameter	Type	Required	Description
schema	IndexSchema	Yes	The schema of the search index.
sync_stat	SyncStat	No	The synchronization status, including the synchronization phase and the duration of the current phase.
metering_info	MeteringInfo	Yes	The metering information, including the storage size, row count, reserved read throughput, and storage duration.
brother_index_name	string	No	The name of the canary index. Returned only when the search index schema is dynamically modified.
query_flow_weight	repeated QueryFlowWeight	No	The query flow weight configurations. Returned only when the search index schema is dynamically modified.
create_time	int64	Yes	The time when the search index was created. The value is a 64-bit timestamp in milliseconds.
time_to_live	int32	Yes	The time-to-live (TTL) of the search index data. Unit: seconds. Data that exceeds the specified TTL is automatically deleted.

Use Tablestore SDKs

The following Tablestore SDKs support the DescribeSearchIndex operation:

Tablestore SDK for Java: Query the description of a search index
Tablestore SDK for Go: Query the description of a search index
Tablestore SDK for Python: Query the description of a search index
Tablestore SDK for Node.js: Query the description of a search index
Tablestore SDK for .NET: Query the description of a search index
Tablestore SDK for PHP: Query the description of a search index