Consulta a descrição de um índice de pesquisa, incluindo informações de campos e configurações do índice.
Sintaxe da solicitação
message DescribeSearchIndexRequest {
optional string table_name = 1;
optional string index_name = 2;
optional bool include_sync_stat = 3;
}
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
table_name |
string |
Não |
Nome da tabela de dados. |
|
index_name |
string |
Não |
Nome do índice de pesquisa. |
|
include_sync_stat |
bool |
Não |
Especifica se o status de sincronização deve ser retornado. Valor padrão: true. |
Sintaxe da resposta
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 |
Obrigatório |
Descrição |
|
schema |
Sim |
Esquema do índice de pesquisa. |
|
|
sync_stat |
Não |
Status de sincronização, incluindo a fase de sincronização e a duração da fase atual. |
|
|
metering_info |
Sim |
Informações de medição, incluindo tamanho de armazenamento, contagem de linhas, throughput de leitura reservado e duração do armazenamento. |
|
|
brother_index_name |
string |
Não |
Nome do índice canário. Retornado apenas quando o esquema do índice de pesquisa é modificado dinamicamente. |
|
query_flow_weight |
repeated QueryFlowWeight |
Não |
Configurações de peso do fluxo de consulta. Retornado apenas quando o esquema do índice de pesquisa é modificado dinamicamente. |
|
create_time |
int64 |
Sim |
Hora de criação do índice de pesquisa. O valor é um timestamp de 64 bits em milissegundos. |
|
time_to_live |
int32 |
Sim |
Tempo de vida (TTL) dos dados do índice de pesquisa. Unidade: segundos. Dados que excedem o TTL especificado são excluídos automaticamente. |
Uso dos SDKs do Tablestore
Os seguintes SDKs do Tablestore oferecem suporte à operação DescribeSearchIndex:
Tablestore SDK for Java: Consultar a descrição de um índice de pesquisa
Tablestore SDK for Go: Consultar a descrição de um índice de pesquisa
Tablestore SDK for Python: Consultar a descrição de um índice de pesquisa
Tablestore SDK for Node.js: Consultar a descrição de um índice de pesquisa
Tablestore SDK for .NET: Consultar a descrição de um índice de pesquisa
Tablestore SDK for PHP: Consultar a descrição de um índice de pesquisa