全部產品
Search
文件中心

:查詢多元索引描述資訊

更新時間:Jul 19, 2024

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

前提條件

介面

/**
 * 擷取資料表的某個多元索引的詳細資料。
 * @api
 *
 * @param [] $request
 *            請求參數,資料表名稱。
 * @return [] 請求返回
 * @throws OTSClientException 當參數檢查出錯或服務端返回校正出錯時拋出異常。
 * @throws OTSServerException 當OTS服務端返回錯誤時拋出異常。
 * @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);

相關文檔

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