建立多元索引後，使用DescribeSearchIndex介面可以查詢多元索引的描述資訊，包括多元索引的欄位資訊、索引配置、計量資訊、建立時間、TTL等。

前提條件

  • 已初始化OTSClient。具體操作，請參見初始化。
  • 已建立資料表並寫入資料。
  • 已在資料表上建立多元索引。具體操作，請參見建立多元索引。

介面

/**
 * 擷取資料表的某個多元索引的詳細資料。
 * @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);