Go SDK を使用してトンネルに関する情報を照会する - Tablestore

トンネルを作成した後、DescribeTunnel オペレーションを呼び出して、トンネル内のチャネルに関する情報など、トンネルに関する情報を照会できます。

前提条件

TunnelClient インスタンスが初期化されていること。
データテーブルに対してトンネルが作成されていること。詳細については、トンネルの作成を参照してください。

パラメーター

リクエストパラメーター

パラメーター	説明
TableName	トンネル情報を照会するデータテーブルの名前。
TunnelName	トンネルの名前。

レスポンスパラメーター

パラメーター	説明
TunnelRPO	トンネルがインクリメンタルデータの消費に使用された最新の時点。この時刻は、トンネル内で最も遅いチャネルがデータの消費に使用された時点です。デフォルト値：1970年1月1日 (UTC)。
List<TunnelInfo>	トンネルに関する情報。レスポンスには以下の情報が含まれます。 TunnelId: トンネルのID。 TunnelName: トンネルの名前。 TunnelType: トンネルのタイプ。有効な値：BaseData、Stream、BaseAndStream。BaseData タイプは、トンネルがデータテーブルのフルデータの消費に使用されることを示します。Stream タイプは、トンネルがデータテーブルのインクリメンタルデータの消費に使用されることを示します。BaseAndStream タイプは、トンネルがデータテーブルの差分データの消費に使用されることを示します。 TableName: トンネルが作成されたデータテーブルの名前。 InstanceName: トンネルが配置されているインスタンスの名前。 Stage: トンネルのステージ。有効な値：InitBaseDataAndStreamShard、ProcessBaseData、ProcessStream。InitBaseDataAndStreamShard ステージは、トンネルが初期化中であることを示します。ProcessBaseData ステージは、トンネルがフルデータの消費に使用されていることを示します。ProcessStream ステージは、トンネルがインクリメンタルデータの消費に使用されていることを示します。 Expired: データが期限切れかどうかを示します。 true が返された場合は、できるだけ早く DingTalk を使用して Tablestore テクニカルサポートに連絡してください。
List<ChannelInfo>	トンネル内のチャネルに関する情報。レスポンスには以下の情報が含まれます。 ChannelId: チャネルのID。 ChannelType: チャネルのタイプ。有効な値：Base と Stream。 ChannelStatus: チャネルのステータス。有効な値：WAIT、OPEN、CLOSING、CLOSE、TERMINATED。 ClientId: トンネルクライアントのID。デフォルトでは、クライアントIDはクライアントのホスト名とランダムな文字列を連結したものです。クライアントのホスト名は TunnelWorkerConfig を使用して指定できます。 ChannelRPO: チャネルがインクリメンタルデータの消費に使用された最新の時点。デフォルト値：1970年1月1日 (UTC)。このパラメーターは、Base タイプのチャネルには適用されません。
ResponseInfo	リクエストで返されるその他のフィールド。リクエスト内の RequestId フィールドを含みます。RequestId はリクエストを一意に識別します。

例

次のサンプルコードは、トンネルがインクリメンタルデータの消費に使用された最新の時点やトンネル内のチャネルに関する情報など、トンネルに関する情報を照会する方法の例を示しています。

req := &tunnel.DescribeTunnelRequest{
   TableName:  "<TABLE_NAME>",
   TunnelName: "TUNNEL_NAME",
}
resp, err := tunnelClient.DescribeTunnel(req)
if err != nil {
   log.Fatal("describe tunnel failed", err) // トンネルの記述に失敗しました
}
log.Println("tunnel id is", resp.Tunnel.TunnelId) // トンネルIDは...です

参照

トンネルに関する情報を照会するために呼び出すことができる API オペレーションについては、DescribeTunnel を参照してください。
Tunnel Service を使用してデータを迅速に消費する方法については、はじめにを参照してください。
テーブルのすべてのトンネルに関する情報を照会できます。詳細については、データテーブルのすべてのトンネルに関する情報の照会を参照してください。
不要になったトンネルを削除できます。詳細については、トンネルの削除を参照してください。