调用DescribeStream获取当前Stream的Shard信息 - 表格存储

调用DescribeStream接口获取当前Stream的Shard信息。

注意事项

读取当前Shard的数据时需要确保父Shard的数据已经全部读取完毕。

请求消息结构

message DescribeStreamRequest {
    required string stream_id = 1;
    optional string inclusive_start_shard_id = 2;
    optional int32 shard_limit = 3;
    optional bool support_timeseries_data_table = 4;
}

名称	类型	是否必选	描述
stream_id	string	是	当前Stream的ID。
inclusive_start_shard_id	string	否	查询起始Shard的ID。
shard_limit	int32	否	单次查询返回Shard数目的上限。
support_timeseries_data_table	bool	否	当前操作的流所属的表是否为时序表。

响应消息结构

message DescribeStreamResponse {
    required string stream_id = 1;
    required int32 expiration_time = 2;
    required string table_name = 3;
    required int64 creation_time = 4;
    required StreamStatus stream_status = 5;
    repeated StreamShard shards = 6;
    optional string next_shard_id = 7;
    optional bool is_timeseries_data_table = 8;
}

名称	类型	描述
stream_id	string	当前Stream的ID。
expiration_time	int32	Stream的过期时间。
table_name	string	当前Stream所属的table名称。
creation_time	int64	当前Stream创建的时间。
stream_status	StreamStatus	当前Stream的状态，包括enabling和active。
shards	StreamShard	Streamshard的信息，包括Shard的ID，父Shard的ID和父Shard的邻居Shard信息。适用于父Shard发生merge。
next_shard_id	string	分页查询下一个Shard的起始ID。
is_timeseries_data_table	bool	流相关联的表格是否为时间序列数据表。

使用SDK

Java SDK：查询表Stream描述信息