文档

ScanTimeseriesData

更新时间:

调用ScanTimeseriesData接口扫描时序数据。

请求消息结构

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

名称

类型

是否必选

描述

table_name

string

时序表名。

split_info

bytes

通过SplitTimeseriesScanTask接口返回的SplitInfo。

start_time_us

int64

开始时间。格式为微秒单位时间戳(从1970-01-01 00:00:00 UTC计算起的微秒数)。

end_time_us

int64

结束时间。格式为微秒单位时间戳(从1970-01-01 00:00:00 UTC计算起的微秒数)。

fields_to_get

repeated TimeseriesFieldsToGet

指定读取部分数据列。

limit

int32

每次最多返回的行数,最大值为5000,默认值为5000。

data_serialize_type

RowsSerializeType

时序数据的行序列化类型。

token

bytes

用于继续获取剩余数据的标识。

supported_table_version

int64

SDK支持的时序表模型版本号。取值范围如下:

  • 0(默认):不支持包含自定义时间线标识或作为主键的数据字段的时序表。

  • 1:支持包含自定义时间线标识和作为主键的数据字段的时序表。

不同版本之间的TimeseriesKey数据结构有所不同,supported_table_version低于操作的时序表模型版本会返回错误。

响应消息结构

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

名称

类型

是否必选

描述

data_serialize_type

RowsSerializeType

时序数据的行序列化类型。

data

bytes

返回的时序数据。

next_token

bytes

用于获取剩余数据的标识。