Consulta la descripción de un índice de búsqueda, incluida la información de los campos y las configuraciones del índice.
Sintaxis de la solicitud
message DescribeSearchIndexRequest {
optional string table_name = 1;
optional string index_name = 2;
optional bool include_sync_stat = 3;
}|
Parámetro |
Tipo |
Obligatorio |
Descripción |
|
table_name |
string |
No |
Nombre de la tabla de datos. |
|
index_name |
string |
No |
Nombre del índice de búsqueda. |
|
include_sync_stat |
bool |
No |
Especifica si se debe devolver el estado de sincronización. Valor predeterminado: true. |
Sintaxis de la respuesta
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
}|
Parámetro |
Tipo |
Obligatorio |
Descripción |
|
schema |
Sí |
Esquema del índice de búsqueda. |
|
|
sync_stat |
No |
Estado de sincronización, que incluye la fase de sincronización y la duración de la fase actual. |
|
|
metering_info |
Sí |
Información de medición, que incluye el tamaño de almacenamiento, el recuento de filas, el rendimiento de lectura reservado y la duración del almacenamiento. |
|
|
brother_index_name |
string |
No |
Nombre del índice canary. Se devuelve únicamente cuando se modifica dinámicamente el esquema del índice de búsqueda. |
|
query_flow_weight |
repeated QueryFlowWeight |
No |
Configuraciones de peso del flujo de consultas. Se devuelven únicamente cuando se modifica dinámicamente el esquema del índice de búsqueda. |
|
create_time |
int64 |
Sí |
Hora en que se creó el índice de búsqueda. El valor es una marca de tiempo de 64 bits en milisegundos. |
|
time_to_live |
int32 |
Sí |
Tiempo de vida (TTL) de los datos del índice de búsqueda. Unidad: segundos. Los datos que superan el TTL especificado se eliminan automáticamente. |
Uso de los SDK de Tablestore
A continuación se listan los SDK de Tablestore compatibles con la operación DescribeSearchIndex:
Tablestore SDK for Java: Query the description of a search index
Tablestore SDK for Go: Query the description of a search index
Tablestore SDK for Python: Query the description of a search index
Tablestore SDK for Node.js: Query the description of a search index
Tablestore SDK for .NET: Query the description of a search index
Tablestore SDK for PHP: Query the description of a search index