Query the description of a search index-Tablestore(Tablestore)-阿里云帮助中心

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. The default value is 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 information of the index.
sync_stat	SyncStat	No	The synchronization information, including the synchronization stage and the time during which the search index remains in the current synchronization stage.
metering_info	MeteringInfo	Yes	The metering information, including the storage size, number of rows, reserved read throughput, and storage duration.
brother_index_name	string	No	The name of the canary index. This parameter is returned only when you update the search index by dynamically modifying the schema of the search index.
query_flow_weight	repeated QueryFlowWeight	No	The weight configurations. This parameter is returned only when you update the search index by dynamically modifying the schema of the search index.
create_time	int64	Yes	The time when the search index was created. The value is a 64-bit timestamp that is accurate to milliseconds.
time_to_live	int32	Yes	The lifecycle of the search index. The value indicates the data retention period. Unit: seconds. If the retention period exceeds the value of this parameter, Tablestore automatically deletes expired data.

Use Tablestore SDKs

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

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
Node.js SDK: 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