調用DescribeStream介面擷取當前Stream的Shard資訊。

注意事項

讀取當前Shard的資料時需要確保父Shard的資料已經全部讀取完畢。

請求訊息結構

message DescribeStreamRequest {
    required string stream_id = 1;
    optional string inclusive_start_shard_id = 2;
    optional int32 shard_limit = 3;
}
名稱 類型 是否必選 描述
stream_id string 是 當前Stream的ID。
inclusive_start_shard_id string 否 查詢起始Shard的ID。
shard_limit int32 否 單次查詢返回Shard數目的上限。

響應訊息結構

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

message StreamShard {
    required string shard_id = 1;
    optional string parent_id = 2;
    optional string parent_sibling_id = 3;
}
名稱 類型 描述
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。

使用SDK

Java SDK：查詢表Stream描述資訊