Todos os produtos
Search

Este produto

    Tablestore:Consultar informações de um túnel

    Central de documentação

    Tablestore:Consultar informações de um túnel

    Última atualização: Jul 03, 2026

    Após criar um túnel, chame a operação DescribeTunnel para consultar informações sobre ele, como os detalhes dos canais associados.

    Pré-requisitos

    • Instância do TunnelClient inicializada.

    • Túnel criado para a tabela de dados. Para mais informações, consulte Criar um túnel.

    Parâmetros

    Parâmetros de solicitação

    Parâmetro

    Descrição

    TableName

    Nome da tabela de dados cujas informações do túnel serão consultadas.

    TunnelName

    Nome do túnel.

    Parâmetros de resposta

    Parâmetro

    Descrição

    TunnelConsumePoint

    Momento mais recente em que o túnel consumiu dados incrementais. Esse horário corresponde ao ponto no tempo em que o canal mais lento do túnel consumiu dados. Valor padrão: 1º de janeiro de 1970 (UTC).

    TunnelInfo

    Informações detalhadas sobre o túnel. A resposta inclui os seguintes dados:

    • TunnelId: ID do túnel.

    • TunnelType: tipo do túnel. Valores válidos: BaseData, Stream e BaseAndStream. O tipo BaseData indica consumo de dados completos da tabela; o tipo Stream refere-se ao consumo de dados incrementais; já o tipo BaseAndStream sinaliza o consumo de dados diferenciais da tabela.

    • TableName: nome da tabela de dados associada ao túnel.

    • InstanceName: nome da instância onde o túnel está localizado.

    • Stage: estágio atual do túnel. Valores válidos: InitBaseDataAndStreamShard, ProcessBaseData e ProcessStream. O estágio InitBaseDataAndStreamShard indica que o túnel está em inicialização; ProcessBaseData significa que o túnel consome dados completos; ProcessStream mostra que o túnel processa dados incrementais.

    • Expired: indica se os dados expiraram.

      Se retornar true, entre em contato com o suporte técnico do Tablestore via DingTalk o mais rápido possível.

    List<ChannelInfo>

    Detalhes sobre os canais presentes no túnel. A resposta contém as seguintes informações:

    • ChannelId: ID do canal.

    • ChannelType: tipo do canal. Valores válidos: BaseData e Stream.

    • ChannelStatus: status atual do canal. Valores válidos: WAIT, OPEN, CLOSING, CLOSE e TERMINATED.

    • ClientId: ID do cliente do túnel. Por padrão, esse ID concatena o hostname do cliente a uma string aleatória. É possível definir o hostname do cliente por meio do TunnelWorkerConfig.

    • ChannelConsumePoint: momento mais recente em que o canal consumiu dados incrementais. Valor padrão: 1º de janeiro de 1970 (UTC). Esse parâmetro não se aplica a canais do tipo BaseData.

    • ChannelCount: quantidade de entradas de dados sincronizadas pelo canal.

    RequestId

    ID da solicitação.

    Exemplos

    O código de exemplo abaixo demonstra como consultar informações de um túnel, incluindo o momento mais recente de consumo de dados incrementais e os detalhes dos canais associados:

    // The most recent time when the tunnel is used to consume incremental data and the recovery point objective (RPO) take effect only if the tunnel is of the Stream type. 
// Stream tunnel: The Stage parameter in TunnelInfo is ProcessStream. Stream channel: The ChannelType parameter in ChannelInfo is Stream. 
private static void describeTunnel(TunnelClient client, String tableName, String tunnelName) {
    DescribeTunnelRequest request = new DescribeTunnelRequest(tableName, tunnelName);
    DescribeTunnelResponse resp = client.describeTunnel(request);
    System.out.println("RequestId: " + resp.getRequestId());
    // The most recent time when the tunnel is used to consume incremental data. The time is the point in time when the slowest channel in the tunnel is used to consume data. Default value: January 1, 1970 (UTC). 
    System.out.println("TunnelConsumePoint: " + resp.getTunnelConsumePoint());
    System.out.println("TunnelInfo: " + resp.getTunnelInfo());
    for (ChannelInfo ci : resp.getChannelInfos()) {
        System.out.println("ChannelInfo::::::");
        System.out.println("\tChannelId: " + ci.getChannelId());
        // The type of the channel. Valid values: BaseData and Stream. 
        System.out.println("\tChannelType: " + ci.getChannelType());
        // The ID of the tunnel client. By default, the client ID concatenates the hostname of the client and a random string. 
        System.out.println("\tClientId: " + ci.getClientId());
        // The most recent time when the channel is used to consume incremental data. 
        System.out.println("\tChannelConsumePoint: " + ci.getChannelConsumePoint());
        // The number of data entries that the channel synchronizes. 
        System.out.println("\tChannelCount: " + ci.getChannelCount());
    }
}

    Referências