Renvoie la description d'un index de recherche, y compris les informations sur les champs et les configurations de l'index.
Syntaxe de la requête
message DescribeSearchIndexRequest {
optional string table_name = 1;
optional string index_name = 2;
optional bool include_sync_stat = 3;
}|
Paramètre |
Type |
Obligatoire |
Description |
|
table_name |
string |
Non |
Nom de la table de données. |
|
index_name |
string |
Non |
Nom de l'index de recherche. |
|
include_sync_stat |
bool |
Non |
Indique si le statut de synchronisation doit être renvoyé. Valeur par défaut : true. |
Syntaxe de la réponse
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
}|
Paramètre |
Type |
Obligatoire |
Description |
|
schema |
Oui |
Schéma de l'index de recherche. |
|
|
sync_stat |
Non |
Statut de synchronisation, incluant la phase de synchronisation et la durée de la phase actuelle. |
|
|
metering_info |
Oui |
Informations de facturation, incluant la taille de stockage, le nombre de lignes, le débit de lecture réservé et la durée de stockage. |
|
|
brother_index_name |
string |
Non |
Nom de l'index canari. Renvoyé uniquement lorsque le schéma de l'index de recherche est modifié dynamiquement. |
|
query_flow_weight |
repeated QueryFlowWeight |
Non |
Configurations de pondération du flux de requêtes. Renvoyées uniquement lorsque le schéma de l'index de recherche est modifié dynamiquement. |
|
create_time |
int64 |
Oui |
Date de création de l'index de recherche. La valeur est un horodatage 64 bits en millisecondes. |
|
time_to_live |
int32 |
Oui |
Durée de vie (TTL) des données de l'index de recherche. Unité : secondes. Les données dépassant la durée de vie spécifiée sont automatiquement supprimées. |
Utiliser les SDK Tablestore
Les SDK Tablestore suivants prennent en charge l'opération DescribeSearchIndex :
SDK Tablestore pour Java : Interroger la description d'un index de recherche
SDK Tablestore pour Go : Interroger la description d'un index de recherche
SDK Tablestore pour Python : Interroger la description d'un index de recherche
SDK Tablestore pour Node.js : Interroger la description d'un index de recherche
SDK Tablestore pour .NET : Interroger la description d'un index de recherche
SDK Tablestore pour PHP : Interroger la description d'un index de recherche