全部产品
Search
文档中心

Tablestore:DescribeStream

更新时间:Jun 24, 2025

Mengambil informasi shard terkait sebuah aliran.

Catatan penggunaan

Sebelum membaca data dari sebuah shard, pastikan semua data dari shard induk telah dibaca terlebih dahulu.

Sintaks permintaan

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

Tipe

Diperlukan

Deskripsi

stream_id

string

Ya

ID dari aliran.

inclusive_start_shard_id

string

Tidak

ID shard awal dalam kueri.

shard_limit

int32

Tidak

Jumlah maksimum shard yang ingin Anda dapatkan sebagai hasil dari kueri.

support_timeseries_data_table

bool

Tidak

Menentukan apakah tabel tempat aliran berada adalah tabel deret waktu.

Sintaks respons

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

Tipe

Deskripsi

stream_id

string

ID dari aliran.

expiration_time

int32

Waktu ketika aliran kedaluwarsa.

table_name

string

Nama tabel tempat aliran berada.

creation_time

int64

Waktu ketika aliran dibuat.

stream_status

StreamStatus

Status aliran. Nilai valid: enabling dan active.

shards

StreamShard

Informasi shard tentang aliran, termasuk ID shard, ID shard induk, dan informasi tentang shard yang berdekatan dengan shard induk. Jika shard induk digabungkan, parameter ini dikembalikan.

next_shard_id

string

ID shard awal dalam kueri halaman berikutnya.

is_timeseries_data_table

bool

Menunjukkan apakah tabel tempat aliran berada adalah tabel deret waktu.

Menggunakan Tablestore SDK

Tablestore SDK untuk Java: DescribeStream