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

Tablestore:UpdateSearchIndex

最終更新日:Dec 28, 2024

検索インデックスの構成(有効期限 (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

QueryFlowWeight

いいえ

重み構成。このパラメーターは、検索インデックスのスキーマを動的に変更する場合にのみ必要です。

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 が返された場合、呼び出しは失敗しました。

    失敗した呼び出しに対してエラーメッセージが返されます。詳細については、エラー を参照してください。

Tablestore SDK の使用

次の Tablestore SDK を使用して、検索インデックスの TTL 構成を更新できます。