すべてのプロダクト
Search
ドキュメントセンター

Tablestore:DescribeStream

最終更新日:Dec 28, 2024

ストリームのシャード情報を照会します。

使用方法

シャードのデータを読み取る前に、親シャードのすべてのデータを読み取る必要があります。

リクエスト構文

message DescribeStreamRequest {
    required string stream_id = 1; // ストリームのID。
    optional string inclusive_start_shard_id = 2; // クエリ内の開始シャードのID。
    optional int32 shard_limit = 3; // クエリで返されるシャードの最大数。
    optional bool support_timeseries_data_table = 4; // ストリームが属するテーブルが時系列テーブルかどうかを指定します。
}

パラメーター

タイプ

必須

説明

stream_id

string

はい

ストリームのID。

inclusive_start_shard_id

string

いいえ

クエリ内の開始シャードのID。

shard_limit

int32

いいえ

クエリで返されるシャードの最大数。

support_timeseries_data_table

bool

いいえ

ストリームが属するテーブルが時系列テーブルかどうかを指定します。

レスポンス構文

message DescribeStreamResponse {
    required string stream_id = 1; // ストリームのID。
    required int32 expiration_time = 2; // ストリームの有効期限。
    required string table_name = 3; // ストリームが属するテーブルの名前。
    required int64 creation_time = 4; // ストリームが作成された時刻。
    required StreamStatus stream_status = 5; // ストリームの状態。有効な値: enabling と active。
    repeated StreamShard shards = 6; // ストリームのシャード情報。シャードID、親シャードID、および親シャードに隣接するシャードの情報が含まれます。親シャードがマージされている場合、このパラメーターが返されます。
    optional string next_shard_id = 7; // 次のページングクエリにおける開始シャードのID。
    optional bool is_timeseries_data_table = 8; // ストリームが属するテーブルが時系列テーブルかどうかを示します。
}

パラメーター

タイプ

説明

stream_id

string

ストリームのID。

expiration_time

int32

ストリームの有効期限。

table_name

string

ストリームが属するテーブルの名前。

creation_time

int64

ストリームが作成された時刻。

stream_status

StreamStatus

ストリームの状態。有効な値:enabling および active。

shards

StreamShard

ストリームのシャード情報。シャードID、親シャードID、および親シャードに隣接するシャードの情報が含まれます。親シャードがマージされている場合、このパラメーターが返されます。

next_shard_id

string

次のページングクエリにおける開始シャードのID。

is_timeseries_data_table

bool

ストリームが属するテーブルが時系列テーブルかどうかを示します。

TableStore SDKの使用

Java用TableStore SDK:DescribeStream