DescribeStream
更新時間：
調(diào)用DescribeStream接口獲取當(dāng)前Stream的Shard信息。
注意事項
讀取當(dāng)前Shard的數(shù)據(jù)時需要確保父Shard的數(shù)據(jù)已經(jīng)全部讀取完畢。
請求消息結(jié)構(gòu)
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 | 是 | 當(dāng)前Stream的ID。 |
inclusive_start_shard_id | string | 否 | 查詢起始Shard的ID。 |
shard_limit | int32 | 否 | 單次查詢返回Shard數(shù)目的上限。 |
support_timeseries_data_table | bool | 否 | 當(dāng)前操作的流所屬的表是否為時序表。 |
響應(yīng)消息結(jié)構(gòu)
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 | 當(dāng)前Stream的ID。 |
expiration_time | int32 | Stream的過期時間。 |
table_name | string | 當(dāng)前Stream所屬的table名稱。 |
creation_time | int64 | 當(dāng)前Stream創(chuàng)建的時間。 |
stream_status | StreamStatus | 當(dāng)前Stream的狀態(tài)，包括enabling和active。 |
shards | StreamShard | Streamshard的信息，包括Shard的ID，父Shard的ID和父Shard的鄰居Shard信息。適用于父Shard發(fā)生merge。 |
next_shard_id | string | 分頁查詢下一個Shard的起始ID。 |
is_timeseries_data_table | bool | 流相關(guān)聯(lián)的表格是否為時間序列數(shù)據(jù)表。 |
使用SDK
文檔內(nèi)容是否對您有幫助？