すべてのプロダクト
Search
ドキュメントセンター

Tablestore:データテーブルのすべてのトンネルに関する情報をクエリする

最終更新日:Dec 28, 2024

トンネルを作成した後、ListTunnel オペレーションを呼び出して、トンネル名、種類、ID、ステージ、データの有効期限など、テーブルのすべてのトンネルに関する情報をクエリできます。

前提条件

  • TunnelClient インスタンスが初期化されている。

  • データテーブルに対してトンネルが作成されている。詳細については、トンネルの作成を参照してください。

パラメーター

リクエストパラメーター

パラメーター

説明

TableName

トンネル情報をクエリするデータテーブルの名前。

レスポンスパラメーター

パラメーター

説明

List<TunnelInfo>

トンネルに関する情報。レスポンスには以下の情報が含まれます。

  • TunnelId: トンネルの ID。

  • TunnelType: トンネルの種類。有効な値: BaseData、Stream、BaseAndStream。BaseData タイプは、トンネルがデータテーブルのフルデータの消費に使用されることを示します。Stream タイプは、トンネルがデータテーブルの増分データの消費に使用されることを示します。BaseAndStream タイプは、トンネルがデータテーブルの差分データの消費に使用されることを示します。

  • TableName: トンネルが作成されたデータテーブルの名前。

  • InstanceName: トンネルが配置されているインスタンスの名前。

  • Stage: トンネルのステージ。有効な値: InitBaseDataAndStreamShard、ProcessBaseData、ProcessStream。InitBaseDataAndStreamShard ステージは、トンネルが初期化中であることを示します。ProcessBaseData ステージは、トンネルがフルデータの消費に使用されていることを示します。ProcessStream ステージは、トンネルが増分データの消費に使用されていることを示します。

  • Expired: データの有効期限が切れているかどうかを示します。

    true が返された場合は、できるだけ早く DingTalk を使用して Tablestore テクニカルサポートに連絡してください。

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 を参照してください。

  • Tunnel Service を使用してデータを迅速に消費する方法については、はじめにを参照してください。

  • トンネルに関する情報をクエリできます。詳細については、トンネルに関する情報のクエリを参照してください。

  • 不要になったトンネルを削除できます。詳細については、トンネルの削除を参照してください。