Scan time series data - Tablestore - Alibaba Cloud Documentation Center

Scans time series data.

Request syntax

message ScanTimeseriesDataRequest {
  required string table_name = 1;
  optional bytes split_info = 2;
  optional int64 start_time_us = 3;
  optional int64 end_time_us = 4;
  repeated TimeseriesFieldsToGet fields_to_get = 5;
  optional int32 limit = 6;
  optional RowsSerializeType data_serialize_type = 7;
  optional bytes token = 8;
  optional int64 supported_table_version = 9;
}

Name	Type	Required	Description
table_name	string	Yes	The name of the time series table.
split_info	bytes	No	The SplitInfo returned by the SplitTimeseriesScanTask operation.
start_time_us	int64	No	The start time. The value of this parameter is a timestamp that specifies the number of microseconds that have elapsed since 00:00:00 UTC on January 1, 1970.
end_time_us	int64	No	The end time. The value of this parameter is a timestamp that specifies the number of microseconds that have elapsed since 00:00:00 UTC on January 1, 1970.
fields_to_get	repeated TimeseriesFieldsToGet	No	The data columns that you want to read.
limit	int32	No	The maximum number of rows to return for a call. Maximum value: 5000. Default value: 5000.
data_serialize_type	RowsSerializeType	No	The serialization type for rows of time series data.
token	bytes	No	The token that is used to read the remaining data.
supported_table_version	int64	No	The model version number of the time series table supported by the Tablestore SDK. Valid values: 0: The model version number does not support time series tables that contain custom time series identifiers and data fields specified as the primary key columns. This is the default value. 1: The model version number supports time series tables that contain custom time series identifiers and data fields specified as the primary key columns. Note The schema specified by TimeseriesKey varies based on the model version number. If the model version number specified by the supported_table_version parameter is earlier than the model version number of the time series table on which you want to perform operations, an error occurs. If you want to develop your own Tablestore SDK, we recommend that you set this parameter to `1`.

Response syntax

message ScanTimeseriesDataResponse {
  optional RowsSerializeType data_serialize_type = 1;
  required bytes data = 2;
  optional bytes next_token = 3;
}

Paramter	Type	Required	Description
data_serialize_type	RowsSerializeType	No	The serialization type for rows of time series data.
data	bytes	Yes	The time series data returned.
next_token	bytes	No	The token that is used to read the remaining data.