Tous les produits
Search

Ce produit

    Tablestore:List tunnels

    Centre de documentation

    Tablestore:List tunnels

    Dernière mise à jour :Aug 20, 2026

    Utilisez le SDK Tablestore pour Java afin de répertorier tous les tunnels d'une table et d'obtenir leurs types, étapes et configurations.

    Prérequis

    Installez le SDK Tablestore pour Java et initialisez TunnelClient.

    Description de la fonctionnalité

    Appelez listTunnel pour répertorier tous les tunnels d'une table. La réponse n'inclut pas les informations relatives aux canaux de chaque tunnel. Pour obtenir les informations sur les canaux, interrogez les détails d'un tunnel spécifique.

    ListTunnelResponse listTunnel(ListTunnelRequest request)
        throws TableStoreException, ClientException

    L'exemple suivant répertorie tous les tunnels de la table example_table et affiche le nom, le type, l'étape et l'heure de création de chaque tunnel :

    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());
}

    Paramètres

    Le paramètre request est de type ListTunnelRequest et contient le paramètre suivant :

    Nom

    Type

    Description

    tableName (obligatoire)

    String

    Le nom de la table.

    Valeurs de retour

    La valeur de retour est de type ListTunnelResponse et contient le champ suivant :

    Nom

    Type

    Description

    tunnelInfos

    List<TunnelInfo>

    La liste des tunnels dans la table. Appelez getTunnelInfos() pour obtenir ce champ.

    Informations sur le tunnel

    Chaque élément du tableau tunnelInfos[] est de type TunnelInfo et contient les champs suivants :

    Nom

    Type

    Description

    tunnelName

    String

    Le nom du tunnel.

    tunnelId

    String

    L'ID du tunnel.

    tunnelType

    TunnelType

    Le type de tunnel. Valeurs possibles : BaseData, Stream et BaseAndStream. Ces valeurs indiquent respectivement les données complètes uniquement, les données incrémentielles uniquement et les données complètes suivies des données incrémentielles.

    tableName

    String

    Le nom de la table.

    instanceName

    String

    Le nom de l'instance.

    stage

    TunnelStage

    L'étape du tunnel. Valeurs possibles : InitBaseDataAndStreamShard, ProcessBaseData et ProcessStream. Ces valeurs indiquent respectivement l'initialisation, le traitement des données complètes et le traitement des données incrémentielles.

    expired

    boolean

    Indique si les données du tunnel ont expiré.

    streamTunnelConfig

    StreamTunnelConfig

    La configuration de la plage de données incrémentielles. Si ce paramètre n'a pas été configuré, la configuration par défaut est renvoyée. Les tunnels de type BaseData n'utilisent pas cette configuration. Pour plus d'informations sur les champs, consultez la rubrique Créer un tunnel.

    createTime

    long

    L'heure de création du tunnel. La valeur est un horodatage UNIX en millisecondes.

    streamRecordOptions

    StreamRecordOptions

    La configuration du contenu des enregistrements incrémentiels. Si ce paramètre n'a pas été configuré, la configuration par défaut est renvoyée. Les tunnels de type BaseData n'utilisent pas cette configuration. Ce champ nécessite le SDK Tablestore pour Java version 5.17.11 ou ultérieure. Pour plus d'informations sur les champs, consultez la rubrique Créer un tunnel.