Query the shard information about a stream - Tablestore - Alibaba Cloud Documentation Center

Usage notes

Read all data from a parent shard before reading data from its child shards.

Request syntax

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;
}

Parameter	Type	Required	Description
stream_id	string	Yes	The stream ID.
inclusive_start_shard_id	string	No	The shard ID from which the query starts. This shard is included in the results.
shard_limit	int32	No	The maximum number of shards to return.
support_timeseries_data_table	bool	No	Specifies whether the table associated with the stream is a time series table.

Response syntax

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;
}

Parameter	Type	Description
stream_id	string	The stream ID.
expiration_time	int32	The expiration time of the stream.
table_name	string	The name of the table associated with the stream.
creation_time	int64	The time when the stream was created.
stream_status	StreamStatus	The stream status. Valid values: `enabling` and `active`.
shards	StreamShard	The shard information for the stream, including the shard ID, parent shard ID, and the shard adjacent to the parent shard. Returned only when parent shards are merged.
next_shard_id	string	The starting shard ID for the next paging query.
is_timeseries_data_table	bool	Indicates whether the table associated with the stream is a time series table.

Use Tablestore SDKs

Tablestore SDK for Java: DescribeStream