全部產品
Search
文件中心

Tablestore:擷取表內的通道資訊

更新時間:Jun 30, 2024

建立通道後,您可以使用ListTunnel介面列舉某個資料表內所有通道的具體資訊,例如通道名稱、通道類型、通道ID、通道所處階段、資料是否超期等。

前提條件

  • 已初始化TunnelClient。

  • 已為資料表建立通道。具體操作,請參見建立通道

參數

請求參數

參數

說明

TableName

列舉通道資訊的資料表名稱。

響應參數

參數

說明

List<TunnelInfo>

通道資訊的列表,包含如下內容:

  • TunnelId:通道的ID。

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

  • TableName:該通道所在的資料表名稱。

  • InstanceName:該通道所在的執行個體名稱。

  • Stage:該通道所處的階段,包括初始化(InitBaseDataAndStreamShard)、全量處理(ProcessBaseData)和增量處理(ProcessStream)三種。

  • Expired:資料是否超期。

    如果該值返回true,請及時通過DingTalk聯絡Table Store支援人員。

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,請及時通過DingTalk聯絡Table Store支援人員。
        System.out.println("\tExpired: " + info.isExpired());
    }
}

相關文檔

  • 關於API說明的更多資訊,請參見ListTunnel

  • 如果要快速使用通道服務消費資料,請參見快速使用通道服務文檔進行操作。

  • 如果要查看指定通道的詳細資料,您可以通過擷取通道的具體資訊實現。更多資訊,請參見擷取通道的具體資訊

  • 如果不再使用某個通道,您可以刪除相應通道。更多資訊,請參見刪除通道