Todos os produtos
Search
Central de documentação

Tablestore:Consultar a descrição de um índice de pesquisa

Última atualização: Sep 18, 2026

Após criar um índice de pesquisa, você pode consultar sua descrição, como as informações de campos e as configurações de pré-ordenação.

Operação de API

Chame a operação DescribeSearchIndex para consultar a descrição de um índice de pesquisa.

Parâmetros

Parâmetro

Descrição

tableName

O nome da tabela de dados.

indexName

O nome do índice de pesquisa.

Métodos

Use o console do Tablestore, o Tablestore CLI ou os SDKs do Tablestore para consultar a descrição de um índice de pesquisa.

Antes de consultar a descrição de um índice de pesquisa, verifique se os seguintes pré-requisitos foram atendidos:

Use the Tablestore console

É possível consultar a descrição de um índice de pesquisa no console do Tablestore, incluindo informações básicas, informações de medição, chave de roteamento, campos do índice e configurações de pré-ordenação.

  1. Acesse a aba Index Management.

    1. Faça login no Table Store console.

    2. Na barra de navegação superior, selecione um grupo de recursos e uma região.

    3. Na página Overview, clique no nome da instância ou clique em Instance Management na coluna Actions.

    4. Na aba Instance Details, na aba Data Table List, clique no nome da tabela de dados ou clique em Index Management na coluna Actions.

  2. Na aba Indexes, clique em Index Details na coluna Actions do índice de pesquisa que deseja gerencie.

  3. Na caixa de diálogo Index Details, consulte as informações básicas, informações de medição, chave de roteamento, campos do índice e configurações de pré-ordenação do índice de pesquisa.

Use the Tablestore CLI

Execute o comando describe_search_index no Tablestore CLI para consultar a descrição de um índice de pesquisa. Para mais informações, consulte Search index.

O exemplo a seguir demonstra como consultar a descrição de um índice de pesquisa chamado search_index:

describe_search_index -n search_index

O código a seguir exibe um exemplo de saída. No resultado do comando, o parâmetro Index schema indica o schema do índice de pesquisa e o parâmetro TimeToLive indica o período de validade dos dados no índice de pesquisa.

Index schema:
{
    "IndexSetting": {
        "RoutingFields": null
    },
    "FieldSchemas": [
        {
            "FieldName": "id",
            "FieldType": "KEYWORD",
            "Index": true,
            "IndexOptions": null,
            "Analyzer": null,
            "AnalyzerParameter": null,
            "EnableSortAndAgg": true,
            "EnableHighlighting": null,
            "Store": false,
            "IsArray": false,
            "FieldSchemas": null,
            "IsVirtualField": false,
            "SourceFieldNames": null,
            "DateFormats": null
        },
        {
            "FieldName": "Col_Keyword",
            "FieldType": "KEYWORD",
            "Index": true,
            "IndexOptions": null,
            "Analyzer": null,
            "AnalyzerParameter": null,
            "EnableSortAndAgg": true,
            "EnableHighlighting": null,
            "Store": false,
            "IsArray": false,
            "FieldSchemas": null,
            "IsVirtualField": false,
            "SourceFieldNames": null,
            "DateFormats": null
        },
        {
            "FieldName": "Col_Long",
            "FieldType": "LONG",
            "Index": true,
            "IndexOptions": null,
            "Analyzer": null,
            "AnalyzerParameter": null,
            "EnableSortAndAgg": true,
            "EnableHighlighting": null,
            "Store": false,
            "IsArray": false,
            "FieldSchemas": null,
            "IsVirtualField": false,
            "SourceFieldNames": null,
            "DateFormats": null
        },
        {
            "FieldName": "Col_Text",
            "FieldType": "TEXT",
            "Index": true,
            "IndexOptions": null,
            "Analyzer": "single_word",
            "AnalyzerParameter": {
                "CaseSensitive": null,
                "DelimitWord": null
            },
            "EnableSortAndAgg": false,
            "EnableHighlighting": null,
            "Store": false,
            "IsArray": false,
            "FieldSchemas": null,
            "IsVirtualField": false,
            "SourceFieldNames": null,
            "DateFormats": null
        },
        {
            "FieldName": "Timestamp",
            "FieldType": "LONG",
            "Index": true,
            "IndexOptions": null,
            "Analyzer": null,
            "AnalyzerParameter": null,
            "EnableSortAndAgg": true,
            "EnableHighlighting": null,
            "Store": false,
            "IsArray": false,
            "FieldSchemas": null,
            "IsVirtualField": false,
            "SourceFieldNames": null,
            "DateFormats": null
        }
    ],
    "IndexSort": {
        "Sorters": [
            {
                "Name": "PrimaryKeySort",
                "Sorter": {
                    "Order": "ASC"
                }
            }
        ]
    }
}
TimeToLive: -1

Use Tablestore SDKs

Consulte a descrição de um índice de pesquisa usando os seguintes SDKs do Tablestore: Tablestore SDK for Java, Tablestore SDK for Go, Tablestore SDK for Python, Tablestore SDK for Node.js, Tablestore SDK for .NET e Tablestore SDK for PHP. Neste exemplo, é utilizado o Tablestore SDK for Java.

O exemplo a seguir consulta example_index para example_table e imprime o status do índice, a fase de sincronização, o TTL e os nomes dos campos.

String tableName = "example_table";
String indexName = "example_index";
DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
request.setTableName(tableName);
request.setIndexName(indexName);
request.setIncludeSyncStat(true);

DescribeSearchIndexResponse response = client.describeSearchIndex(request);
System.out.println(response.getIndexStatus().indexStatusEnum);
System.out.println(response.getSyncStat().getSyncPhase());
System.out.println(response.getTimeToLive());
for (FieldSchema fieldSchema : response.getSchema().getFieldSchemas()) {
    System.out.println(fieldSchema.getFieldName());
}

Referências

Se um índice de pesquisa existente não atender mais aos seus requisitos, crie um novo índice de pesquisa, modifique o schema do índice existente para adicionar, remover ou alterar campos do índice, ou ajuste a configuração de TTL do índice de pesquisa. Para mais informações, consulte Create a search index, Dynamically modify the schema of a search index e Specify the TTL of a search index.