Queries the details of a tunnel.
Request syntax
message DescribeTunnelRequest {
required string table_name = 1;
required string tunnel_name = 2;
optional string tunnel_id = 3;
}
Parameter | Type | Required | Description |
table_name | string | Yes | The name of the table. |
tunnel_name | string | Yes | The name of the tunnel. |
tunnel_id | string | No | The ID of the tunnel. |
Response syntax
message DescribeTunnelResponse {
required TunnelInfo tunnel = 1;
repeated ChannelInfo channels = 2;
optional int64 tunnel_rpo = 3;
}Parameter | Type | Required | Description |
tunnel | Yes | The information about the tunnel. | |
channels | Yes | The information about the channel. | |
tunnel_rpo | int64 | No | The recovery point objective (RPO) of the tunnel. |
Use Tablestore SDKs
You can query the tunnel information by using the following SDKs:
Tablestore SDK for Java: Query the information of a tunnel
Tablestore SDK for Go: Query the information of a tunnel