Table Store Java SDK 列出通道 - Tablestore

前提條件

功能說明

調用 listTunnel 列出指定資料表的所有通道。返回結果不包含通道內的 Channel 資訊；如需查看 Channel 資訊，請查詢單個通道的詳細資料。

ListTunnelResponse listTunnel(ListTunnelRequest request)
        throws TableStoreException, ClientException

以下樣本列出 example_table 資料表的所有通道，並輸出通道名稱、類型、運行階段和建立時間。

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

參數說明

request 的類型為 ListTunnelRequest，包含以下參數：

名稱	類型	說明
tableName（必選）	`String`	資料表名稱。

傳回值

傳回值類型為 ListTunnelResponse，包含以下欄位：

名稱	類型	說明
tunnelInfos	`List<TunnelInfo>`	資料表下的通道資訊列表。通過 `getTunnelInfos()` 擷取。

通道資訊

tunnelInfos[] 的類型為 TunnelInfo，包含以下欄位：

名稱	類型	說明
tunnelName	`String`	通道名稱。
tunnelId	`String`	通道 ID。
tunnelType	`TunnelType`	通道類型。取值為 `BaseData`、`Stream` 或 `BaseAndStream`，分別表示僅消費全量資料、僅消費增量資料或先消費全量資料再消費增量資料。
tableName	`String`	資料表名稱。
instanceName	`String`	執行個體名稱。
stage	`TunnelStage`	通道運行階段。取值為 `InitBaseDataAndStreamShard`、`ProcessBaseData` 或 `ProcessStream`，分別表示初始化、處理全量資料或處理增量資料。
expired	`boolean`	通道資料是否已到期。
streamTunnelConfig	`StreamTunnelConfig`	增量資料範圍配置。未設定時返回預設配置；`BaseData` 類型不使用該配置。有關欄位含義，請參見建立通道。
createTime	`long`	通道建立時間，格式為毫秒級 Unix 時間戳記。
streamRecordOptions	`StreamRecordOptions`	增量記錄內容配置。未設定時返回預設配置；`BaseData` 類型不使用該配置。該欄位需要使用 5.17.11 及以上版本的 Java SDK。有關欄位含義，請參見建立通道。