不要になったトンネルを削除するには、DeleteTunnel オペレーションを呼び出します。トンネルを削除する際は、トンネルが作成されたデータテーブルの名前とトンネルの名前を指定する必要があります。
使用上の注意
チャネルを削除する前に、チャネルでデータが消費されていないことを確認してください。そうでない場合、データ消費が失敗する可能性があります。
チャネルは、削除されると復元できません。この操作を実行する際は注意してください。
前提条件
TunnelClient インスタンスが初期化されていること。
データテーブルに対してトンネルが作成されていること。詳細については、トンネルの作成を参照してください。
パラメーター
リクエストパラメーター
パラメーター | 説明 |
tableName | トンネルを削除するデータテーブルの名前。ListTable オペレーションを呼び出して、インスタンス内のテーブルの名前をクエリできます。詳細については、テーブル名のリストを参照してください。 |
tunnelName | トンネルの名前。ListTunnel オペレーションを呼び出して、データテーブルのすべてのトンネルに関する情報をクエリできます。詳細については、データテーブルのすべてのトンネルに関する情報のクエリを参照してください。 |
レスポンスパラメーター
パラメーター | 説明 |
responseInfo | リクエストで返されるその他のフィールド。 |
requestId | リクエストの ID。 |
例
次のサンプルコードは、データテーブルのトンネルを削除する方法の例を示しています。
private static void deleteTunnel(TunnelClient client, String tableName, String tunnelName) {
DeleteTunnelRequest request = new DeleteTunnelRequest(tableName, tunnelName);
DeleteTunnelResponse resp = client.deleteTunnel(request);
System.out.println("RequestId: " + resp.getRequestId());
}関連情報
トンネルを削除するために呼び出すことができる API オペレーションについては、DeleteTunnel を参照してください。
DeleteTunnel オペレーションの呼び出し時にエラーが発生した場合は、エラーメッセージに基づいてエラーコードでエラー原因を検索し、エラーを処理してください。