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;
}Parameter | Type | Required | Description |
table_name | string | Yes | The name of the time series table. |
split_info | bytes | No | The SplitInfo parameter that is 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 in a call. Maximum value: 5000. Default value: 5000. |
data_serialize_type | No | The serialization type for rows of time series data. | |
token | bytes | No | The token that is used to read the remaining data. |
Response syntax
message ScanTimeseriesDataResponse {
optional RowsSerializeType data_serialize_type = 1;
required bytes data = 2;
optional bytes next_token = 3;
}Parameter | Type | Required | Description |
data_serialize_type | 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. |