You can call the DescribeSearchIndex operation to query the description of a search index for a table, including the fields, configurations, read and write capacity units (CUs), and creation time of the search index.
Prerequisites
- A Tablestore client is initialized. For more information, see Initialization.
- A data table is created. Data is written to the table.
- A search index is created for the data table. For more information, see Create search indexes.
Parameters
Parameter | Description |
---|---|
tableName | The name of the data table. |
indexName | The name of the search index. |
Examples
client.describeSearchIndex({
tableName: TABLE_NAME, // Specify the name of the data table.
indexName: INDEX_NAME // Specify the name of the search index.
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', JSON.stringify(data, null, 2));
});