表格存储 Java SDK 列出通道 - 表格存储

前提条件

功能说明

调用 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。有关字段含义，请参见创建通道。