All Products
Search
Document Center

Tablestore:DescribeSearchIndex

Last Updated:Apr 11, 2026

Mengkueri informasi tentang indeks pencarian, seperti informasi bidang dan konfigurasi indeks.

Sintaksis permintaan

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

Parameter

Tipe

Wajib

Deskripsi

table_name

string

Tidak

Nama tabel data.

index_name

string

Tidak

Nama indeks pencarian.

include_sync_stat

bool

Tidak

Menentukan apakah akan mengembalikan status sinkronisasi. Nilai default-nya adalah true.

Sintaksis respons

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
}

Parameter

Tipe

Wajib

Deskripsi

schema

IndexSchema

Ya

Informasi skema dari indeks.

sync_stat

SyncStat

Tidak

Informasi sinkronisasi, termasuk tahap sinkronisasi dan durasi waktu selama indeks pencarian berada dalam tahap sinkronisasi tersebut.

metering_info

MeteringInfo

Ya

Informasi metering, termasuk ukuran penyimpanan, jumlah baris, reserved read throughput, dan storage duration.

brother_index_name

string

Tidak

Nama indeks canary. Parameter ini hanya dikembalikan saat Anda memperbarui indeks pencarian dengan memodifikasi skema indeks pencarian secara dinamis.

query_flow_weight

repeated QueryFlowWeight

Tidak

Konfigurasi bobot. Parameter ini hanya dikembalikan saat Anda memperbarui indeks pencarian dengan memodifikasi skema indeks pencarian secara dinamis.

create_time

int64

Ya

Waktu pembuatan indeks pencarian. Nilainya berupa timestamp 64-bit yang akurat hingga milidetik.

time_to_live

int32

Ya

Lifecycle dari indeks pencarian. Nilai ini menunjukkan periode retensi data. Satuan: detik.

Jika periode retensi melebihi nilai parameter ini, Tablestore akan secara otomatis menghapus data yang telah kedaluwarsa.

Gunakan SDK Tablestore

Anda dapat menggunakan SDK Tablestore berikut untuk mengkueri deskripsi indeks pencarian: