多次元インデックスの説明のクエリ - Tablestore - Alibaba Cloud ドキュメントセンター

検索インデックスのフィールド情報やインデックス構成などの情報を照会します。

リクエスト構文

message DescribeSearchIndexRequest {
    optional string table_name = 1;
    optional string index_name = 2;
    optional bool include_sync_stat = 3;
}

パラメーター	型	必須	説明
table_name	string	いいえ	データテーブルの名前。
index_name	string	いいえ	検索インデックスの名前です。
include_sync_stat	bool	いいえ	同期ステータスを返すかどうかを指定します。デフォルト値は true です。

レスポンス構文

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	IndexSchema	はい	インデックスのスキーマ情報。
sync_stat	SyncStat	いいえ	同期情報。同期ステージと、多次元インデックスが現在の同期ステージに留まる時間を含みます。
metering_info	MeteringInfo	はい	メータリング情報。ストレージサイズ、行数、予約済み読み取りスループット、保存期間を含みます。
brother_index_name	string	いいえ	カナリアインデックスの名前です。このパラメーターは、検索インデックスのスキーマを動的に変更して検索インデックスを更新する場合にのみ返されます。
query_flow_weight	repeated QueryFlowWeight	いいえ	重みの構成。このパラメーターは、検索インデックスのスキーマを動的に変更して検索インデックスを更新する場合にのみ返されます。
create_time	int64	はい	検索インデックスが作成された時刻です。値はミリ秒単位の 64 ビットタイムスタンプです。
time_to_live	int32	はい	多次元インデックスのライフサイクル。値はデータ保持期間を示します。単位：秒。保持期間がこのパラメーターの値を超えると、Tablestore は期限切れのデータを自動的に削除します。

Tablestore SDK の使用

次の Tablestore SDK を使用して、多次元インデックスの説明をクエリできます：

Tablestore Java SDK: 検索インデックスの説明を照会する
Tablestore SDK for GO：多次元インデックスの説明のクエリ
Tablestore Python 用 SDK: 検索インデックスの説明を照会する
Node.js SDK: 検索インデックスの説明を照会する
Tablestore SDK for .NET: 検索インデックスの説明の照会
Tablestore SDK for PHP：多次元インデックスの説明のクエリ