All Products
Search
Document Center

Tablestore:TunnelInfo

Last Updated:May 31, 2024

TunnelInfo specifies the tunnel information in the response to the ListTunnel and DescribeTunnel operations.

Data structure

message TunnelInfo {
    required string tunnel_id = 1;
    required string tunnel_type = 2;
    required string table_name = 3;
    required string instance_name = 4;
    required string stream_id = 5;
    required string stage = 6;
    optional bool expired = 7;
    optional string tunnel_name = 8;
    optional StreamTunnelConfig stream_tunnel_config = 10;
    optional int64  create_time = 11;
}

Parameter

Type

Required

Description

tunnel_id

string

Yes

The ID of the tunnel. Each tunnel ID is unique.

tunnel_type

string

Yes

The type of the tunnel.

table_name

string

Yes

The name of the table.

instance_name

string

Yes

The name of the instance.

stream_id

string

Yes

The ID of the stream.

stage

string

Yes

The stage of the tunnel. Valid values:

  • InitBaseDataAndStreamShard: the initialization stage

  • ProcessBaseData: the full processing stage

  • ProcessStream: the incremental stage

expired

bool

No

Indicates whether the tunnel has expired.

tunnel_name

string

No

The name of the tunnel.

stream_tunnel_config

StreamTunnelConfig

No

The stream configuration for the incremental stage of the tunnel.

create_time

int64

No

The time when the tunnel was created.

Related operations