Get Asset AI Raw Data¶
获取指定设备的指定测点(支持多设备多测点)在某段时间内的AI原始数据。
请求格式¶
POST https://{apigw-address}/tsdb-service/v2.1/ai
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 资产所属的组织ID。如何获取orgId信息>> |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
modelId | 可选 | String | 资产所属模型ID。如何获取modelId信息>> |
assetIds | 必需 | String | 资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
pointIds | 必需 | String | 资产测点,支持多测点查询,各个测点间用英文逗号隔开。如何获取pointId信息>> |
startTime | 必需 | String | 采样数据开始时间,支持local时间和UTC时间。local时间的格式为 YYYY-MM-DD HH:MM:SS 。当格式为local时间时,使用设备所在地的当地时间进行查询。UTC时间格式需要加入时区信息,例如:2019-06-01T00:00:00+08:00 。当格式为UTC时间时,对所有资产按照统一的开始时间和结束时间进行查询。 |
endTime | 必需 | String | 采样数据结束时间,格式必须与开始时间保持一致。 |
pageSize | 可选 | Integer | 单次查询返回记录条数的上限,默认为1000。 |
withQuality | 可选 | Boolean | 指定返回结果中是否包含数据质量位,true 为包含,false 表示不包含。 |
localTimeAccuracy | 可选 | Boolean | 指定查询结果是否包含毫秒级结果。true 表示需要毫秒格式,false 表示不需要毫秒格式。 |
localTimeFormat | 可选 | Integer | 指定返回数据的local时间是否包含设备时区信息。0:不包含设备时区信息;1:包含设备时区信息;默认值为0。 |
itemFormat | 可选 | Integer | 指定返回结果中测点数据的显示格式。可选值为0,1,2,默认值为0。对每种显示格式的详细介绍,参见 Item Format 示例>> |
boundaryType | 可选 | String | 若测点已配置数据压缩存储,指定查询的测点数据类型。可选值为:inside (查询原始压缩数据,此为默认值)、outside (查询原始压缩数据+返回起止时间边界前后的数据)、interpolated (查询原始压缩数据+返回起止时间边界插值数据,即插补起止时间点的数据)、sample (返回起止时间内,按指定时间间隔和算法插补的数据)。插补的数据可按业务需要用于补全TSDB中的数据。 |
interval | 可选 | Integer | 当 boundaryType=sample 时,指定插补数据的时间间隔,默认值为60,单位为秒。 |
interpolation | 可选 | String | 当 boundaryType=sample 时,指定插补数据的算法。可选值为:linear (线性填充值,此为默认值)、previous (之前的一个值)、near (临近的一个值)、after (之后的一个值)。有关插值算法的详细信息,参见 数据插值算法参考说明>> |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | List<JSONObject> | 资产数据列表。单设备单点的返回数据按时间升序排列。详见 items |
items¶
示例¶
{
"localtime":"2020-04-20T00:00:03+08:00",
"assetId": "yourAssetId",
"yourPointId": 1.1236,
"timestamp": 1587312003000
}
参数¶
名称 | 数据类型 | 描述 |
---|---|---|
assetId | String | 资产ID。 |
timestamp | Long | 数据时间戳,UNIX时间,精确到秒。 |
pointId | Double | 此参数是变量,在返回数据中显示为传入测点的标识符与查询到的测点数据。 |
localtime | String | 数据本地时间标记,精确到秒。返回结果是否包含设备时区信息,由 localTimeFormat 参数指定。 |
示例 1¶
请求示例¶
Local时间格式:
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-04-20 00:00:00",
"endTime": "2020-04-21 00:00:000",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 1,
"itemFormat": 0,
"withQuality": false
}
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1587312000000,
"yourPointId": 1.1236,
"localtime": "2020-04-20T00:00:00+08:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1587312003000,
"yourPointId": 1.1236,
"localtime": "2020-04-20T00:00:03+08:00"
}
]
}
}
示例 2¶
请求示例¶
UTC时间格式:
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-04-20T00:00:00+08:00",
"endTime": "2020-04-21T00:00:00+08:00",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 0,
"itemFormat": 0,
"withQuality": false
}
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1587312000000,
"yourPointId": 1.1236,
"localtime": "2020-04-20 00:00:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1587312003000,
"yourPointId": 1.1236,
"localtime": "2020-04-20 00:00:03"
}
]
}
}
示例 3¶
请求示例¶
带数据质量位的查询:
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-04-20T00:00:00+08:00",
"endTime": "2020-04-21T00:00:00+08:00",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 0,
"itemFormat": 0,
"withQuality": true
}
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1587312000000,
"yourPointId": 1.1236,
"localtime": "2020-04-20 00:00:00",
"quality": 0
},
{
"assetId": "yourAssetId",
"timestamp": 1587312003000,
"yourPointId": 1.1236,
"localtime": "2020-04-20 00:00:03",
"quality": 0
}
]
}
}
示例 4¶
请求示例¶
查询原始压缩数据,并返回查询起止时间边界前后的数据。
url: https://{apigw-address}/tsdb-service/v2.1/ai?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-08-28T11:33:00+08:00",
"endTime": "2020-08-28T11:35:00+08:00",
"boundaryType", "outside"
}
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1598585576906,
"yourPointId": 0.8807087,
"localtime": "2020-08-28 11:32:56"
},
{
"assetId": "yourAssetId",
"timestamp": 1598585587039,
"yourPointId": 0.26798052,
"localtime": "2020-08-28 11:33:07"
},
{
"assetId": "yourAssetId",
"timestamp": 1598585597125,
"yourPointId": 0.65514636,
"localtime": "2020-08-28 11:33:17"
},
{
"assetId": "yourAssetId",
"timestamp": 1598585708013,
"yourPointId": 0.342161,
"localtime": "2020-08-28 11:35:08"
}
]
}
}