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

  • An OTSClient instance 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.

API operations

/**
 * Query the description of a search index that is created for a table. 
 * @api
 *
 * @param [] $request
 *            The request parameter, which is the table name. 
 * @return [] The response.
 * @throws OTSClientException The exception that is returned when a parameter error occurs or the Tablestore server returns a verification error. 
 * @throws OTSServerException The exception that is returned when the Tablestore server returns an error. 
 * @example "src/examples/DescribeSearchIndex.php" 20
 */
public function describeSearchIndex(array $request)

Parameters

ParameterDescription
table_nameThe name of the data table.
index_nameThe name of the search index.

Examples

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index'
);
$response = $otsClient->describeSearchIndex($request);