全部產品
Search
文件中心

Tablestore:CreateSearchIndex

更新時間:Jun 30, 2024

調用CreateSearchIndex介面建立一個多元索引。

說明

關於多元索引的更多資訊,請參見多元索引介紹

注意事項

建立多元索引前,請確保資料表的最大版本數為1,資料生命週期滿足如下條件中的任意一個。

  • 資料表的資料生命週期為-1(資料永不到期)。

  • 資料表的資料生命週期不為-1時,資料表為禁止更新狀態(即是否允許更新)。

請求訊息結構

message CreateSearchIndexRequest {
    required string table_name = 1;
    required string index_name = 2;
    optional IndexSchema schema = 3;
    optional string source_index_name = 4;
    optional int32 time_to_live = 5; // unit is seconds
}

名稱

類型

是否必選

描述

table_name

string

資料表名稱。

index_name

string

多元索引名稱。

schema

IndexSchema

多元索引Schema。

source_index_name

string

源多元索引名稱。只有當使用動態修改schema時才需要設定此參數。

time_to_live

int32

多元索引生命週期,即資料的儲存時間。預設值為-1。單位為秒。

當資料的儲存時間超過設定的資料生命週期時,系統會自動清理超過資料生命週期的資料。

資料生命週期至少為86400秒(一天)或-1(資料永不到期)。

關於多元索引生命週期的更多資訊,請參見生命週期管理

響應訊息結構

message CreateSearchIndexResponse {
}

您需要通過判斷HTTP請求的status取值是否為200來確定是否執行成功。

  • 如果status取值為200,則表示執行成功。

  • 如果status取值為400或者500,則表示執行失敗。

    如果請求執行失敗時,則會返回Error資訊。更多資訊,請參見Error

使用SDK

您可以使用如下語言的SDK建立多元索引。