Query Historical Measurement Point


根据对象实例标识符等信息获取测点的时序数据。

请求格式


GET/POST https://{api-gateway}/cds-timeseries-service/v1.0/tsdb-detail?action=query

请求参数


名称

位置

必需/可选

数据类型

描述

orgId

Query

必需

String

测点所属的组织 ID。如何获取 orgId 信息>>

mdmIds

Query/Form

必需

String

测点对应的对象实例的标识符,多个对象实例之间用英文逗号隔开。单次查询指定的对象实例数量不超过 20000。为保证查询性能,建议单次查询指定的对象实例数量不超过 100。

pointIdsWithLogic

Query/Form

必需

String

带聚合逻辑的测点,格式为:函数(测点标识符),多个测点之间用英文逗号隔开,例如:sum(pointId1),sum(pointId2)。单次查询指定的测点数量不超过 100。支持的聚合计算方式有 count, avg, sum, max, min, first, last。聚合查询的时间区间为 [startTime,endTime),即聚合操作数包含 startTime 时刻的数据,但不包含 endTime 时刻的数据。如何获取 pointId 信息>>

startTime

Query/Form

必需

String

采样数据开始时间。本地时间查询格式:yyyy-MM-dd HH:mm:ss;UTC 时间查询格式:yyyy-MM-ddTHH:mm:ssZ。使用本地时间时,通用数据服务根据每个查询资产所在时区的当地时间进行查询。

endTime

Query/Form

必需

String

采样数据结束时间,格式必须与开始时间保持一致。开始时间和结束时间之间的天数不超过 90。

interval

Query/Form

必需

Integer

测点聚合的时间粒度。目前支持以下时间粒度:RAW(原始数据),1m(1分钟),5m(5分钟),10m(10分钟),15m(15分钟),30m(30分钟),H(小时)。需保证 (endTime-startTime) / interval 得到的值不超过 12000,即:开始时间与结束时间之间包含指定时间粒度的数量不超过 12000。

pageSize

Query/Form

可选

Integer

分页查询时单个页面中单个设备的单个测点返回记录的条数。需保证 mdmIds * pointIdsWithLogic * pageSize 得到的值不超过 120000。

autoInterpolate

Query/Form

可选

Boolean

是否采用空值前的最新数据对空值进行补齐,默认为 false。

withQuality

Query/Form

可选

Boolean

是否返回数据质量标签,默认为 false。

返回内容类型


application/json; charset = UTF-8

响应参数


名称

必然/可能返回

数据类型

描述

mdmId

必然返回

String

测点所属的对象实例的标识符。为保证查询性能,建议单次查询指定的对象实例数量不超过 100。

timestamp

必然返回

Long

数据时间戳(UNIX 时间)。

localtime

必然返回

String

数据本地时间标记。

point

必然返回

Object

描述测点的时序数值。

返回码


参见 通用数据服务 API 返回码

示例

请求示例


GET https://{api-gateway}/cds-timeseries-service/v1.0/tsdb-detail?action=query&orgId=yourOrgId&mdmIds=yourMdmId&pointIdsWithLogic=yourPointIdsWithLogic&startTime=yourStartTime&endTime=yourEndTime&interval=yourInterval

返回示例


{
  "code": 0,
  "msg": "OK",
  "data": {
    "items": [
      {
        "mdmId": "yourMdmId",
        "timestamp": 1560249312446,
        "localtime": "2019-06-11T18:35:12.123+08:00",
        "windspeed": 1.1236,
        "power": 1.1236
      },
      {
        "mdmId": "yourMdmId",
        "timestamp": 1560249312446,
        "localtime": "2019-06-11T18:35:12.123+08:00",
        "windspeed": 1.1236,
        "power": 1.1236
      },
      {
        "mdmId": "yourMdmId",
        "timestamp": 1560249312444,
        "localtime": "2019-06-11T18:35:12.123+08:00",
        "windspeed": 1.1236
      }
    ]
  },
  "traceId": "1234567890abcdefghijkl0987654321"
}