查詢多元索引的描述資訊 - Tablestore

調用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查詢多元索引描述資訊。