トンネルを作成した後、DescribeTunnel オペレーションを呼び出して、トンネル内のチャネルに関する情報など、トンネルに関する情報を照会できます。
前提条件
TunnelClient インスタンスが初期化されている。
データテーブルに対してトンネルが作成されている。 詳細については、トンネルの作成を参照してください。
パラメーター
リクエストパラメーター
パラメーター | 説明 |
TableName | トンネル情報を照会するデータテーブルの名前。 |
TunnelName | トンネルの名前。 |
レスポンスパラメーター
パラメーター | 説明 |
TunnelConsumePoint | トンネルを使用して増分データを消費した最新の時点。 この時刻は、トンネル内で最も遅いチャネルがデータの消費に使用された時点です。 デフォルト値:1970年1月1日 (UTC)。 |
TunnelInfo | トンネルに関する情報。 レスポンスには以下の情報が含まれます。
|
List<ChannelInfo> | トンネル内のチャネルに関する情報。 レスポンスには以下の情報が含まれます。
|
RequestId | リクエストのID。 |
例
次のサンプルコードは、トンネルが増分データの消費に使用された最新の時点やトンネル内のチャネルに関する情報など、トンネルに関する情報を照会する方法の例を示しています。
// トンネルが増分データの消費に使用された最新の時点と目標復旧時点 (RPO) は、トンネルのタイプが Stream の場合にのみ有効になります。
// ストリームトンネル: TunnelInfo の Stage パラメーターは ProcessStream です。 ストリームチャネル: ChannelInfo の ChannelType パラメーターは Stream です。
private static void describeTunnel(TunnelClient client, String tableName, String tunnelName) {
DescribeTunnelRequest request = new DescribeTunnelRequest(tableName, tunnelName);
DescribeTunnelResponse resp = client.describeTunnel(request);
System.out.println("RequestId: " + resp.getRequestId());
// トンネルが増分データの消費に使用された最新の時点。 この時刻は、トンネル内で最も遅いチャネルがデータの消費に使用された時点です。 デフォルト値:1970年1月1日 (UTC)。
System.out.println("TunnelConsumePoint: " + resp.getTunnelConsumePoint());
System.out.println("TunnelInfo: " + resp.getTunnelInfo());
for (ChannelInfo ci : resp.getChannelInfos()) {
System.out.println("ChannelInfo::::::");
System.out.println("\tChannelId: " + ci.getChannelId());
// チャネルのタイプ。 有効な値:BaseData および Stream。
System.out.println("\tChannelType: " + ci.getChannelType());
// トンネルクライアントの ID。 デフォルトでは、クライアント ID はクライアントのホスト名とランダムな文字列を連結したものです。
System.out.println("\tClientId: " + ci.getClientId());
// チャネルが増分データの消費に使用された最新の時点。
System.out.println("\tChannelConsumePoint: " + ci.getChannelConsumePoint());
// チャネルが同期するデータエントリの数。
System.out.println("\tChannelCount: " + ci.getChannelCount());
}
}
関連情報
トンネルに関する情報を照会するために呼び出すことができる API オペレーションについては、DescribeTunnel を参照してください。
Tunnel Service を使用してデータをすばやく消費する方法については、はじめにを参照してください。
テーブルのすべてのトンネルに関する情報を照会できます。 詳細については、データテーブルのすべてのトンネルに関する情報の照会を参照してください。
不要になったトンネルを削除できます。 詳細については、トンネルの削除を参照してください。