获取表内的通道信息

创建通道后,您可以使用ListTunnel接口列举某个数据表内所有通道的具体信息,例如通道名称、通道类型、通道ID、通道所处阶段、数据是否超期等。

前提条件

  • 已初始化TunnelClient。

  • 已为数据表创建通道。具体操作,请参见创建通道

参数

请求参数

参数

说明

TableName

列举通道信息的数据表名称。

响应参数

参数

说明

List<TunnelInfo>

通道信息的列表,包含如下内容:

  • TunnelId:通道的ID。

  • TunnelType:通道的类型,包括全量(BaseData)、增量(Stream)和全量加增量(BaseAndStream)三种。

  • TableName:该通道所在的数据表名称。

  • InstanceName:该通道所在的实例名称。

  • Stage:该通道所处的阶段,包括初始化(InitBaseDataAndStreamShard)、全量处理(ProcessBaseData)和增量处理(ProcessStream)三种。

  • Expired:数据是否超期。

    如果该值返回true,请及时通过钉钉联系表格存储技术支持。

ResponseInfo

返回的一些其它字段,包括当次请求的RequestId。RequestId用于唯一标识此次请求。

示例

以下示例用于获取指定表下的通道信息。

req := &tunnel.ListTunnelRequest{
    TableName: "<TABLE_NAME>",
}
resp, err := tunnelClient.ListTunnel(req)
if err != nil {
    log.Fatal("List tunnel failed", err)
} else {
    for i := 0; i < len(resp.Tunnels); i++ {
        log.Println(resp.Tunnels[i].TableName, resp.Tunnels[i].TunnelName, resp.Tunnels[i].TunnelId)
    }
}

相关文档

  • 关于API说明的更多信息,请参见ListTunnel

  • 如果要快速使用通道服务消费数据,请参见快速使用通道服务文档进行操作。

  • 如果要查看指定通道的详细信息,您可以通过获取通道的具体信息实现。更多信息,请参见获取通道的具体信息

  • 如果不再使用某个通道,您可以删除相应通道。更多信息,请参见删除通道