Todos os produtos
Search
Central de documentação

Tablestore:Consultar informações do tunnel

Última atualização: Aug 01, 2026

Use o Tablestore SDK for Java para consultar a configuração, o estágio, o status dos canais e o progresso de consumo incremental de um tunnel.

Pré-requisitos

Instale o Tablestore SDK for Java e inicialize o TunnelClient.

Descrição do recurso

Chame describeTunnel para consultar informações sobre um tunnel. A resposta inclui a configuração do tunnel, o ponto geral de consumo incremental, o objetivo de ponto de recuperação (RPO), o status e o progresso de consumo de cada canal no tunnel.

DescribeTunnelResponse describeTunnel(DescribeTunnelRequest request)
        throws TableStoreException, ClientException

O exemplo a seguir consulta informações do tunnel example_tunnel da tabela example_table e imprime o estágio do tunnel, o status e o progresso de consumo de cada canal:

String tableName = "example_table";
String tunnelName = "example_tunnel";

DescribeTunnelRequest request =
        new DescribeTunnelRequest(tableName, tunnelName);
DescribeTunnelResponse response = tunnelClient.describeTunnel(request);

TunnelInfo tunnelInfo = response.getTunnelInfo();
System.out.printf(
        "name=%s, type=%s, stage=%s%n",
        tunnelInfo.getTunnelName(),
        tunnelInfo.getTunnelType(),
        tunnelInfo.getStage());

for (ChannelInfo channelInfo : response.getChannelInfos()) {
    System.out.printf(
            "channelId=%s, type=%s, status=%s, count=%d%n",
            channelInfo.getChannelId(),
            channelInfo.getChannelType(),
            channelInfo.getChannelStatus(),
            channelInfo.getChannelCount());
}

Parâmetros

request é do tipo DescribeTunnelRequest e contém os seguintes parâmetros:

Nome

Tipo

Descrição

tableName (obrigatório)

String

Nome da tabela.

tunnelName (obrigatório)

String

Nome do tunnel.

Valores de retorno

O valor retornado é do tipo DescribeTunnelResponse e contém os seguintes campos:

Nome

Tipo

Descrição

tunnelConsumePoint

Date

Ponto mais recente de consumo incremental do tunnel. Corresponde ao ponto de consumo do canal mais lento no tunnel. Valor padrão: 00:00:00 de 1º de janeiro de 1970 (UTC). Chame getTunnelConsumePoint() para obter este campo.

tunnelRpo

long

RPO de consumo incremental do tunnel. Representa a diferença entre a hora atual e o ponto de consumo do canal mais lento. Unidade: milissegundos. Chame getTunnelRpo() para obter este campo.

tunnelInfo

TunnelInfo

Informações do tunnel. Chame getTunnelInfo() para obter este campo. Os campos são idênticos aos dos objetos TunnelInfo retornados por List tunnels.

channelInfos

List<ChannelInfo>

Lista de canais no tunnel. Se o tunnel não tiver inicializado nenhum canal, o sistema retorna uma lista vazia. Chame getChannelInfos() para obter este campo.

Nota

Os campos tunnelConsumePoint e tunnelRpo aplicam-se apenas ao consumo incremental. Se o consumo incremental ainda não tiver iniciado ou se o tunnel consumir apenas dados completos, tunnelConsumePoint assumirá o valor padrão. Nesse caso, não use tunnelRpo para determinar a latência de consumo.

Informações do canal

Cada elemento em channelInfos[] é do tipo ChannelInfo e contém os seguintes campos:

Nome

Tipo

Descrição

channelId

String

ID do canal.

channelType

ChannelType

Tipo do canal. Valores válidos: BaseData e Stream, que indicam, respectivamente, um canal de dados completos e um canal de dados incrementais.

channelStatus

ChannelStatus

Status do canal. Valores válidos: WAIT, OPEN, CLOSING, CLOSE e TERMINATED, que indicam, respectivamente: aguardando, aberto, fechando, fechado e encerrado.

clientId

String

ID do cliente que consome o canal. Este campo pode estar vazio se nenhum cliente estiver atribuído ao canal. O ID do cliente é gerado com base em TunnelWorkerConfig.clientTag. Chame setClientTag() para personalizar o identificador do cliente.

channelConsumePoint

Date

Ponto mais recente de consumo incremental do canal. Valor padrão: 00:00:00 de 1º de janeiro de 1970 (UTC). Este campo não se aplica a canais de dados completos.

channelRpo

long

RPO de consumo incremental do canal. Corresponde à diferença entre a hora atual e channelConsumePoint. Unidade: milissegundos. Este campo não se aplica a canais de dados completos.

channelCount

long

Quantidade de linhas sincronizadas pelo canal.