Time-to-Live (TTL) やスキーマ設定など、検索インデックスの設定を更新します。
注意事項
-
検索インデックスの TTL を更新するには、検索インデックスが作成されているデータテーブルの
allow_updateパラメータがfalseに設定されていることを確認してください。詳細については、「UpdateTable」をご参照ください。 -
SDK を使用して特定の API を呼び出し、検索インデックスのスキーマを変更する場合、操作が複雑になります。Tablestore コンソールで検索インデックスのスキーマを変更することを推奨します。詳細については、「検索インデックスのスキーマを動的に変更する」をご参照ください。
リクエスト構文
message UpdateSearchIndexRequest {
optional string table_name = 1;
optional string index_name = 2;
optional string switch_index_name = 3;
repeated QueryFlowWeight query_flow_weight = 4;
optional int32 time_to_live = 5; // 単位は秒
}
|
パラメータ |
型 |
必須 |
説明 |
|
table_name |
string |
はい |
データテーブルの名前です。 |
|
index_name |
string |
はい |
検索インデックスの名前です。 |
|
switch_index_name |
string |
いいえ |
検索インデックスの新しい名前です。このパラメータは、検索インデックスのスキーマを動的に変更する場合にのみ必須です。 |
|
query_flow_weight |
いいえ |
重み設定です。このパラメータは、検索インデックスのスキーマを動的に変更する場合にのみ必須です。 |
|
|
time_to_live |
int32 |
いいえ |
検索インデックス内のデータの保持期間です。単位:秒。 デフォルト値は -1 で、データが期限切れにならないことを意味します。TTL は、少なくとも 86,400 秒 (1 日) または -1 である必要があります。 データの保持期間が TTL を超えると、データは期限切れになります。Tablestore は、期限切れのデータを自動的に削除します。 検索インデックスの TTL は、検索インデックスが作成されているデータテーブルの TTL とは独立しており、データテーブルの TTL を超えることはできません。検索インデックスと、その対象データテーブルの TTL を減少させる場合は、データテーブルの TTL を変更する前に、検索インデックスの TTL を変更する必要があります。 |
レスポンス構文
message UpdateSearchIndexResponse {
}
正常な呼び出しでは、HTTP ステータスコード 200 が返されます。その他のステータスコードは失敗を示します。
HTTP 200:呼び出しが成功しました。
-
HTTP 400 または 500:呼び出しが失敗しました。
応答にはエラーメッセージが含まれます。詳細については、「Error」をご参照ください。
Tablestore SDK の使用
次の Tablestore SDK を使用して、検索インデックスの設定を更新できます。