查询多元索引的描述信息 - 表格存储

调用DescribeSearchIndex接口查询多元索引描述信息，包括多元索引的字段信息和索引配置等。

请求消息结构

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

名称	类型	是否必选	描述
table_name	string	否	数据表名称。
index_name	string	否	多元索引名称。

响应消息结构

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
}

名称	类型	是否必选	描述
schema	IndexSchema	是	索引Schema信息。
sync_stat	SyncStat	否	同步状态，包括同步阶段以及当前同步阶段的时间。
metering_info	MeteringInfo	是	计量信息，包括存储量大小、行数、预留读吞吐量和时间。
brother_index_name	string	否	灰度索引的名称。当使用动态修改schema功能更新多元索引结构时才会返回此参数。
query_flow_weight	repeated QueryFlowWeight	否	查询权重配置。当使用动态修改schema功能更新多元索引结构时才会返回此参数。
create_time	int64	是	多元索引的创建时间。格式为64位的毫秒单位时间戳。
time_to_live	int32	是	多元索引生命周期，即数据的保存时间。单位为秒。当数据的保存时间超过设置的数据生命周期时，系统会自动清理超过数据生命周期的数据。

使用SDK

您可以使用如下语言的SDK查询多元索引描述信息。