Todos os produtos
Search
Central de documentação

Tablestore:DescribeStream

Última atualização: Sep 22, 2026

Consulta as informações de shard (partição) de um stream (fluxo de dados).

Notas de uso

Leia todos os dados de um shard pai antes de ler os dados de seus shards filhos.

Sintaxe da requisição

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

Parâmetro

Tipo

Obrigatório

Descrição

stream_id/@parmname

string

Sim

O ID do stream.

inclusive_start_shard_id/@parmname

string

Não

O ID do shard a partir do qual a consulta começa. Esse shard é incluído nos resultados.

shard_limit/@parmname

int32

Não

O número máximo de shards a retornar.

support_timeseries_data_table/@parmname

bool

Não

Especifica se a tabela associada ao stream é uma tabela de séries temporais.

Sintaxe da resposta

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

Parâmetro

Tipo

Descrição

stream_id/@parmname

string

O ID do stream.

expiration_time/@parmname

int32

O tempo de expiração do stream.

table_name/@parmname

string

O nome da tabela associada ao stream.

creation_time/@parmname

int64

A hora de criação do stream.

stream_status/@parmname

StreamStatus

O status do stream. Valores válidos: enabling e active.

shards/@parmname

StreamShard

As informações de shard do stream, incluindo o ID do shard, o ID do shard pai e o shard adjacente ao shard pai. Retornado somente quando shards pai são mesclados.

next_shard_id/@parmname

string

O ID do shard inicial para a próxima consulta paginada.

is_timeseries_data_table/@parmname

bool

Indica se a tabela associada ao stream é uma tabela de séries temporais.

Usar SDKs do Tablestore

SDK do Tablestore para Java: DescribeStream