Todos os produtos
Search
Central de documentação

Tablestore:Listar túneis

Última atualização: Aug 20, 2026

Use o Tablestore SDK for Java para listar todos os túneis de uma tabela e obter seus tipos, estágios e configurações.

Pré-requisitos

Instale o Tablestore SDK for Java e inicialize o TunnelClient.

Descrição do recurso

Chame listTunnel para listar todos os túneis de uma tabela. A resposta não inclui informações sobre os canais de cada túnel. Para obter detalhes sobre os canais, consulte as informações de um túnel específico.

ListTunnelResponse listTunnel(ListTunnelRequest request)
        throws TableStoreException, ClientException

O exemplo a seguir lista todos os túneis da tabela example_table e imprime o nome, o tipo, o estágio e o horário de criação de cada túnel:

String tableName = "example_table";

ListTunnelRequest request = new ListTunnelRequest(tableName);
ListTunnelResponse response = tunnelClient.listTunnel(request);

for (TunnelInfo tunnelInfo : response.getTunnelInfos()) {
    System.out.printf(
            "name=%s, type=%s, stage=%s, createTime=%d%n",
            tunnelInfo.getTunnelName(),
            tunnelInfo.getTunnelType(),
            tunnelInfo.getStage(),
            tunnelInfo.getCreateTime());
}

Parâmetros

request é do tipo ListTunnelRequest e contém o seguinte parâmetro:

Nome

Tipo

Descrição

tableName (obrigatório)

String

Nome da tabela.

Valores de retorno

O valor retornado é do tipo ListTunnelResponse e contém o seguinte campo:

Nome

Tipo

Descrição

tunnelInfos

List<TunnelInfo>

Lista de túneis da tabela. Chame getTunnelInfos() para obter este campo.

Informações do túnel

Cada elemento em tunnelInfos[] é do tipo TunnelInfo e contém os seguintes campos:

Nome

Tipo

Descrição

tunnelName

String

Nome do túnel.

tunnelId

String

ID do túnel.

tunnelType

TunnelType

Tipo do túnel. Valores válidos: BaseData, Stream e BaseAndStream. Indicam, respectivamente, apenas dados completos, apenas dados incrementais e dados completos seguidos por dados incrementais.

tableName

String

Nome da tabela.

instanceName

String

Nome da instância.

stage

TunnelStage

Estágio do túnel. Valores válidos: InitBaseDataAndStreamShard, ProcessBaseData e ProcessStream. Representam, nesta ordem, inicialização, processamento de dados completos e processamento de dados incrementais.

expired

boolean

Indica se os dados do túnel expiraram.

streamTunnelConfig

StreamTunnelConfig

Configuração do intervalo de dados incrementais. Se não definida, o sistema retorna a configuração padrão. Túneis do tipo BaseData não usam esta configuração. Para mais detalhes sobre os campos, consulte Crie um túnel.

createTime

long

Horário de criação do túnel. O valor é um timestamp UNIX em milissegundos.

streamRecordOptions

StreamRecordOptions

Configuração do conteúdo de registros incrementais. Se não especificada, o sistema retorna a configuração padrão. Este parâmetro não se aplica a túneis do tipo BaseData. Requer o Tablestore SDK for Java 5.17.11 ou posterior. Para obter informações detalhadas sobre os campos, consulte Crie um túnel.