Get Asset AI Data with Aggregation Logic

获取指定设备的指定测点在某段时间内的AI分钟级归一化数据,并支持对查询到的数据进行聚合处理。

操作权限

需授权的资源

所需操作权限

资产

Read

有关各资源及其对应的权限,参考 策略,角色,与权限>>

使用GET方法

请求格式

GET https://{apigw-address}/tsdb-service/v2.0/ai-normalized

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织ID。如何获取orgId信息>>

modelId

Query

可选

String

资产所属模型ID。如何获取modelId信息>>

assetIds

Query

必需

String

资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>>

measurepointsWithLogic

Query

必需

String

测点数据聚合逻辑,支持的聚合计算方式有count, avg, sum, max, min, first, last。聚合查询的时间区间为 [startTime,endTime),即聚合操作数包含 startTime 时刻的数据,但不包含 endTime 时刻的数据。支持查询的测点数3000。格式为:函数(测点标识符),例如:sum(pointId)如何获取pointId信息>>

interval

Query

必需

Integer

聚合算法作用的时间间隔,有效值为0-1440,单位是分钟。当间隔为0,测点不能带聚合逻辑;当间隔值大于0,测点必须带聚合逻辑。

startTime

Query

必需

String

采样数据开始时间,支持local时间和UTC时间。local时间的格式为 YYYY-MM-DD HH:MM:SS。当格式为local时间时,使用设备所在地的当地时间进行查询。UTC时间格式需要加入时区信息,例如:2019-06-01T00:00:00+08:00。当格式为UTC时间时,对所有资产按照统一的开始时间和结束时间进行查询。

endTime

Query

必需

String

采样数据结束时间,格式必须与开始时间保持一致。

pageSize

Query

可选

Integer

单次查询返回记录条数的上限,默认为1000。

accessKey

Query

可选

String

应用的服务账号,应用以accessKey进行鉴权以获得其被授权访问的数据。如何获取accessKey信息>>

localTimeAccuracy

Query

可选

Boolean

指定查询结果是否包含毫秒级结果。true 表示需要毫秒格式,false 表示不需要毫秒格式。

响应参数

名称

数据类型

描述

data

List<JSONObject>

资产数据列表。单设备单点的返回数据按时间升序排列。详见 items

items

示例
{
        "sum(yourPointId)": 4.4944,
        "assetId": "yourAssetId",
        "timestamp": 1560249300000,
        "localtime": "2019-06-11 18:35:00"
}
参数

名称

数据类型

描述

pointIdWithLogic

Double

此参数是变量,表示测点标识符(带聚合逻辑或不带)与对应数据。

assetId

String

资产ID。

timestamp

Long

数据时间戳,UNIX时间,精确到秒。

localtime

String

数据本地时间标记,精确到秒,当入参时间格式为UTC格式时,该值为null。

错误码

有关错误码的描述,参见 通用错误码

示例 1

请求示例

Local时间格式:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized?orgId=yourOrgId&modelId=&assetIds=yourAssetID&measurepointsWithLogic=sum(yourPointId)&interval=10&startTime=2019-06-01%2000:00:00&endTime=2019-06-11%2023:00:00&pageSize=&accessKey=accessKeyOfYourAPP

method: GET

返回示例

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "sum(yourPointId)": 4.4944,
        "assetId": "yourAssetId",
        "timestamp": 1560249300000,
        "localtime": "2019-06-11 18:35:00"
      },
      {
        "sum(yourPointId)": 6.0,
        "assetId": "yourAssetId",
        "timestamp": 1560257100000,
        "localtime": "2019-06-11 20:45:00"
      }
    ]
  }
}

示例 2

请求示例

UTC时间格式:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized?accessKey=accessKeyOfYourAPP&assetIds=yourAssetIds&pageSize=5000&interval=10&startTime=2019-06-01T00:00:00%2B08:00&endTime=2019-06-11T23:00:00%2B08:00&orgId=yourOrgId&measurepointsWithLogic=sum(yourPointIds)

method: GET

返回示例

{
    "status": 0,
    "requestId": null,
    "msg": "success",
    "submsg": null,
    "data": {
        "items": [
            {
                "localtime": null,
                "sum(yourPointId)": 4.4944,
                "assetId": "yourAssetId",
                "timestamp": 1560249300000
            },
            {
                "localtime": null,
                "sum(yourPointId)": 6.0,
                "assetId": "yourAssetId",
                "timestamp": 1560257100000
            }
        ]
    }
}

使用POST方法

请求格式

POST https://{apigw-address}/tsdb-service/v2.0/ai-normalized

请求参数(Body)

名称

必需/可选

数据类型

描述

orgId

必需

String

资产所属的组织ID。如何获取orgId信息>>

modelId

可选

String

资产所属模型ID。如何获取modelId信息>>

assetIds

必需

String

资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>>

measurepointsWithLogic

必需

String

测点数据聚合逻辑,支持的聚合计算方式有count, avg, sum, max, min, first, last。聚合查询的时间区间为 [startTime,endTime),即聚合操作数包含 startTime 时刻的数据,但不包含 endTime 时刻的数据。格式为:函数(测点标识符),例如:sum(pointId)如何获取pointId信息>>

interval

必需

String

聚合算法作用的时间间隔,有效值为0-1440,单位是分钟。当间隔为0,测点不能带聚合逻辑;当间隔值大于0,测点必须带聚合逻辑。

startTime

必需

String

采样数据开始时间,支持local时间和UTC时间。local时间的格式为 YYYY-MM-DD HH:MM:SS。当格式为local时间时,使用设备所在地的当地时间进行查询。UTC时间格式需要加入时区信息,例如:2019-06-01T00:00:00+08:00。当格式为UTC时间时,对所有资产按照统一的开始时间和结束时间进行查询。

endTime

必需

String

采样数据结束时间,格式必须与开始时间保持一致。

pageSize

可选

String

单次查询返回记录条数的上限,默认为1000。

accessKey

可选

String

应用的服务账号,应用以accessKey进行鉴权以获得其被授权访问的数据。如何获取accessKey信息>>

localTimeAccuracy

可选

String

指定查询结果是否包含毫秒级结果。true 表示需要毫秒格式,false 表示不需要毫秒格式。

响应参数

参见 使用GET方法 中的描述。

错误码

有关错误码的描述,参见通用错误码

示例 1

请求示例

Local时间格式:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized

method: POST

Content-Type: multipart/form-data;charset=UTF-8

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "yourAssetIds",
  "measurepointsWithLogic": "sum(yourPointId)",
  "startTime": "2020-04-20 00:00:00",
  "endTime": "2020-04-21 00:00:00",
  "interval": 10,
  "pageSize": 10,
  "accessKey": "accessKey of your APP"
}

返回示例

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "sum(yourPointId)": 4.4944,
        "assetId": "yourAssetId",
        "timestamp": 1560249300000,
        "localtime": "2019-06-11 18:35:00"
      },
      {
        "sum(yourPointId)": 6.0,
        "assetId": "yourAssetId",
        "timestamp": 1560257100000,
        "localtime": "2019-06-11 20:45:00"
      }
    ]
  }
}

示例 2

请求示例

UTC时间格式:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized

method: POST

Content-Type: multipart/form-data;charset=UTF-8

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "yourAssetIds",
  "measurepointsWithLogic": "sum(yourPointId)",
  "startTime": "2019-06-01T00:00:00%2B08:00",
  "endTime": "2019-06-11T23:00:00%2B08:00",
  "interval": 10,
  "pageSize": 10,
  "accessKey": "accessKey of your APP"
}

返回示例

{
    "status": 0,
    "requestId": null,
    "msg": "success",
    "submsg": null,
    "data": {
        "items": [
            {
                "localtime": null,
                "sum(yourPointId)": 4.4944,
                "assetId": "yourAssetId",
                "timestamp": 1560249300000
            },
            {
                "localtime": null,
                "sum(yourPointId)": 6.0,
                "assetId": "yourAssetId",
                "timestamp": 1560257100000
            }
        ]
    }
}

SDK 示例


你可以在 Github 上获取 TSDB 数据服务的 Java SDK 示例