フィールド情報やインデックス設定など、検索インデックスに関する情報をクエリします。
リクエスト構文
message DescribeSearchIndexRequest {
optional string table_name = 1;
optional string index_name = 2;
}パラメーター | タイプ | 必須 | 説明 |
table_name | string | いいえ | データテーブルの名前。 |
index_name | string | いいえ | 検索インデックスの名前。 |
レスポンス構文
message DescribeSearchIndexResponse {
optional IndexSchema schema = 1;
optional SyncStat sync_stat = 2;
optional MeteringInfo metering_info = 3;
optional string brother_index_name = 4;
repeated QueryFlowWeight query_flow_weight = 5;
optional int64 create_time = 6;
optional int32 time_to_live = 7; // unit is seconds
}パラメーター | タイプ | 必須 | 説明 |
schema | はい | インデックスのスキーマ情報。 | |
sync_stat | いいえ | 同期情報。同期ステージと、検索インデックスが現在の同期ステージにとどまっている時間を含みます。 | |
metering_info | はい | メータリング情報。ストレージサイズ、行数、予約済み読み取りスループット、ストレージ期間を含みます。 | |
brother_index_name | string | いいえ | カナリーインデックスの名前。このパラメーターは、検索インデックスのスキーマを動的に変更することで検索インデックスを更新した場合にのみ返されます。 |
query_flow_weight | repeated QueryFlowWeight | いいえ | 重み設定。このパラメーターは、検索インデックスのスキーマを動的に変更することで検索インデックスを更新した場合にのみ返されます。 |
create_time | int64 | はい | 検索インデックスが作成された時刻。値はミリ秒単位の精度の64ビットタイムスタンプです。 |
time_to_live | int32 | はい | 検索インデックスのライフサイクル。値はデータ保持期間を示します。単位：秒。 保持期間がこのパラメーターの値を超えると、Tablestoreは期限切れのデータを自動的に削除します。 |
Tablestore SDKの使用
以下のTablestore SDKを使用して、検索インデックスの説明をクエリできます。
Tablestore SDK for Java：検索インデックスの説明をクエリする
Tablestore SDK for GO：検索インデックスの説明をクエリする
Tablestore SDK for Python：検索インデックスの説明をクエリする
Tablestore SDK for Node.js：検索インデックスの説明をクエリする
Tablestore SDK for .NET：検索インデックスの説明をクエリする
Tablestore SDK for PHP：検索インデックスの説明をクエリする