トンネル情報のクエリ - Tablestore SDK for Java - Tablestore - Alibaba Cloud ドキュメントセンター

Tablestore SDK for Java を使用して、トンネルの構成、ステージ、チャンネル状態、および増分消費の進捗をクエリします。

前提条件

Tablestore SDK for Java をインストールし、TunnelClient を初期化します。

機能説明

describeTunnel を呼び出して、トンネルに関する情報をクエリします。応答には、トンネルの構成、全体的な増分消費ポイントと目標復旧時点 (RPO)、およびトンネル内の各チャンネルの状態と消費の進捗が含まれます。

DescribeTunnelResponse describeTunnel(DescribeTunnelRequest request)
        throws TableStoreException, ClientException

次の例では、example_table テーブルの example_tunnel トンネルに関する情報を照会し、トンネルステージ、各チャンネルの状態、および消費の進捗状況を出力します。

String tableName = "example_table";
String tunnelName = "example_tunnel";

DescribeTunnelRequest request =
        new DescribeTunnelRequest(tableName, tunnelName);
DescribeTunnelResponse response = tunnelClient.describeTunnel(request);

TunnelInfo tunnelInfo = response.getTunnelInfo();
System.out.printf(
        "name=%s, type=%s, stage=%s%n",
        tunnelInfo.getTunnelName(),
        tunnelInfo.getTunnelType(),
        tunnelInfo.getStage());

for (ChannelInfo channelInfo : response.getChannelInfos()) {
    System.out.printf(
            "channelId=%s, type=%s, status=%s, count=%d%n",
            channelInfo.getChannelId(),
            channelInfo.getChannelType(),
            channelInfo.getChannelStatus(),
            channelInfo.getChannelCount());
}

パラメーター

request は DescribeTunnelRequest 型で、次のパラメーターを含みます。

名前	型	説明
tableName (必須)	`String`	テーブルの名前。
tunnelName (必須)	`String`	トンネルの名前。

戻り値

戻り値は DescribeTunnelResponse 型で、次のフィールドを含みます。

名前	型	説明
tunnelConsumePoint	`Date`	トンネルの最新の増分消費ポイント。値は、トンネル内で最も遅いチャンネルの消費ポイントです。デフォルト値：1970年1月1日 00:00:00 (協定世界時 (UTC))。このフィールドを取得するには `getTunnelConsumePoint()` を呼び出します。
tunnelRpo	`long`	トンネルの増分消費の RPO。これは、現在の時刻と最も遅いチャンネルの消費ポイントとの差です。単位：ミリ秒。このフィールドを取得するには `getTunnelRpo()` を呼び出します。
tunnelInfo	`TunnelInfo`	トンネル情報。このフィールドを取得するには `getTunnelInfo()` を呼び出します。フィールドは、トンネルのリストによって返される `TunnelInfo` オブジェクトのフィールドと同じです。
channelInfos	`List<ChannelInfo>`	トンネル内のチャンネルのリスト。トンネルがチャンネルを初期化していない場合、空のリストが返されます。このフィールドを取得するには `getChannelInfos()` を呼び出します。

説明

tunnelConsumePoint と tunnelRpo は増分消費にのみ適用されます。増分消費が開始されていない場合、またはトンネルが完全データのみを消費する場合、tunnelConsumePoint はデフォルト値になります。この場合、tunnelRpo を使用して消費レイテンシーを判断しないでください。

チャンネル情報

channelInfos[] の各要素は ChannelInfo 型で、次のフィールドを含みます。

名前	型	説明
channelId	`String`	チャンネル ID。
channelType	`ChannelType`	チャンネルの型。有効値：`BaseData` (完全データチャンネル) と `Stream` (増分データチャンネル)。
channelStatus	`ChannelStatus`	チャンネルの状態。有効値：`WAIT` (待機中)、`OPEN` (オープン)、`CLOSING` (クローズ中)、`CLOSE` (クローズ済み)、`TERMINATED` (終了)。
clientId	`String`	チャンネルを消費するクライアントの ID。チャンネルにクライアントが割り当てられていない場合、このフィールドは空になることがあります。クライアント ID は `TunnelWorkerConfig.clientTag` に基づいて生成されます。`setClientTag()` を呼び出してクライアント識別子をカスタマイズできます。
channelConsumePoint	`Date`	チャンネルの最新の増分消費ポイント。デフォルト値：1970年1月1日 00:00:00 (協定世界時 (UTC))。このフィールドは完全データチャンネルには適用されません。
channelRpo	`long`	チャンネルの増分消費の RPO。これは、現在の時刻と `channelConsumePoint` との差です。単位：ミリ秒。このフィールドは完全データチャンネルには適用されません。
channelCount	`long`	チャンネルによって同期された行数。