全部產品
Search
文件中心

:查詢多元索引描述資訊

更新時間:Jul 24, 2024

建立多元索引後,使用DescribeSearchIndex介面可以查詢多元索引的描述資訊,包括多元索引的欄位資訊和索引配置等。

前提條件

參數

參數

說明

tableName

資料表名稱。

indexName

多元索引名稱。

樣本

以下樣本用於擷取多元索引的詳細資料,例如資料生命週期、建立時間、同步狀態、欄位資訊等。

client.describeSearchIndex({
    tableName: TABLE_NAME, //設定資料表名稱。
    indexName: INDEX_NAME  //設定多元索引名稱。
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

相關文檔

如果已有多元索引不滿足使用需求,您可以建立新的多元索引、通過修改多元索引的Schema來增刪改多元索引欄位或者根據需要調整多元索引的TTL。具體操作,請參見建立多元索引動態修改schema生命週期管理