All Products
Search
Document Center

Tablestore:GetShardIterator

Last Updated:Aug 23, 2024

Queries the start iterator that is used to read data from a shard.

Request syntax

message GetShardIteratorRequest {
    required string stream_id = 1;
    required string shard_id = 2;
    optional int64 timestamp = 3;
    optional string token = 4;
}

Parameter

Type

Required

Description

stream_id

string

Yes

The ID of the stream.

shard_id

string

Yes

The ID of the shard.

timestamp

int64

No

The timestamp based on which you want to obtain a shard iterator. Unit: μs.

token

string

No

The token that is used to obtain results in pages.

Response syntax

message GetShardIteratorResponse {
    required string shard_iterator = 1;
    optional string next_token = 2;
}

Parameter

Type

Description

shard_iterator

string

The start iterator that is used to read data from the shard.

next_token

string

The token that is used to obtain the next iterator.

Use Tablestore SDKs

Tablestore SDK for Java: GetShardIterator