创建通道后,您可以使用ListTunnel接口列举某个数据表内所有通道的具体信息,例如通道名称、通道类型、通道ID、通道所处阶段、数据是否超期等。
前提条件
已初始化TunnelClient。
已为数据表创建通道。具体操作,请参见创建通道。
参数
请求参数
参数 | 说明 |
TableName | 列举通道信息的数据表名称。 |
响应参数
参数 | 说明 |
List<TunnelInfo> | 通道信息的列表,包含如下内容:
|
RequestId | 当次请求的Request ID。 |
示例
以下示例用于获取指定表下的通道信息。
private static void listTunnel(TunnelClient client, String tableName) {
ListTunnelRequest request = new ListTunnelRequest(tableName);
ListTunnelResponse resp = client.listTunnel(request);
System.out.println("RequestId: " + resp.getRequestId());
for (TunnelInfo info : resp.getTunnelInfos()) {
System.out.println("TunnelInfo::::::");
System.out.println("\tTunnelName: " + info.getTunnelName());
System.out.println("\tTunnelId: " + info.getTunnelId());
//通道的类型,包括全量(BaseData)、增量(Stream)和全量加增量(BaseAndStream)三种。
System.out.println("\tTunnelType: " + info.getTunnelType());
System.out.println("\tTableName: " + info.getTableName());
System.out.println("\tInstanceName: " + info.getInstanceName());
//通道所处的阶段,包括初始化(InitBaseDataAndStreamShard)、全量处理(ProcessBaseData)和增量处理(ProcessStream)三类。
System.out.println("\tStage: " + info.getStage());
//数据是否超期。如果该值返回true,请及时通过钉钉联系表格存储技术支持。
System.out.println("\tExpired: " + info.isExpired());
}
}
相关文档
关于API说明的更多信息,请参见ListTunnel。
如果要快速使用通道服务消费数据,请参见快速使用通道服务文档进行操作。
如果要查看指定通道的详细信息,您可以通过获取通道的具体信息实现。更多信息,请参见获取通道的具体信息。
如果不再使用某个通道,您可以删除相应通道。更多信息,请参见删除通道。