すべてのプロダクト
Search
ドキュメントセンター

Tablestore:検索インデックス詳細のクエリ

最終更新日:Sep 21, 2026

検索インデックスを作成した後、DescribeSearchIndex API を使用して、検索インデックスの詳細をクエリできます。詳細には、フィールド情報、インデックス設定、メータリング情報、作成時刻、検索インデックスの TTL が含まれます。

前提条件

API オペレーション

/**
 * テーブルに作成された検索インデックスの説明をクエリします。
 * @api
 *
 * @param [] $request
 *            リクエストパラメーター。
 * @return [] 応答。
 * @throws OTSClientException パラメーターエラーが発生した場合、または Tablestore サーバーが検証エラーを返した場合にスローされる例外。
 * @throws OTSServerException Tablestore サーバーがエラーを返した場合にスローされる例外。
 * @example "src/examples/DescribeSearchIndex.php" 20
 */
public function describeSearchIndex(array $request)

パラメーター

パラメーター

説明

table_name

データテーブルの名前。

index_name

検索インデックスの名前。

例

次のサンプルコードは、検索インデックスの説明をクエリする方法を示しています。

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

関連ドキュメント

既存の検索インデックスが要件を満たさなくなった場合は、新しい検索インデックスを作成するか、既存の検索インデックスのスキーマを変更してインデックスフィールドを追加、削除、または変更するか、検索インデックスの TTL 設定を調整できます。詳細については、「検索インデックスの作成」および「検索インデックスのスキーマの動的な変更」をご参照ください。