Get Asset Unified Raw Data¶
用于查询 标准数据 + 非标准数据 的统一接口。支持标准数据的插补(插补的参数 boundaryType
、interval
和interpolation
只作用于标准数据)。
请求格式¶
GET https://{apigw-address}/tsdb-service/v2.0/unified-raw
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 资产所属的组织ID。如何获取orgId信息>> |
modelId | Query | 可选 | String | 资产所属模型ID。如何获取modelId信息>> |
assetIds | Query | 必需 | String | 资产ID,支持查询多个资产,多个资产 ID 之间用英文逗号隔开。如何获取Asset ID信息>> |
pointIds | Query | 必需 | String | 资产测点,支持多测点查询,包括标准测点和非标准测点,多个测点 ID 之间用英文逗号隔开。设备数量 * 测点数量 <= 3000。如何获取pointId信息>> |
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。返回总数据量遵循约束:(设备数量 * 测点数量 * pagesize)≤ 640000。 |
localTimeAccuracy | Query | 可选 | Boolean | 指定查询结果是否包含毫秒级结果。true 表示需要毫秒格式,false 表示不需要毫秒格式。默认值为 false 。 |
localTimeFormat | Query | 可选 | Integer | 指定返回数据的local时间是否包含设备时区信息。0:不包含设备时区信息;1:包含设备时区信息;默认值为 0。 |
itemFormat | Query | 可选 | Integer | 指定返回结果中测点数据的显示格式。可选值为:0、1、2,默认值为 0。对每种显示格式的详细介绍,参见 Item Format 示例>> |
withQuality | Query | 可选 | Boolean | 该参数仅对标准数据有效。指定返回结果中是否包含数据质量位,true 为包含,false 表示不包含。默认值为 false 。 |
orderBy | Query | 可选 | String | 指定返回结果按照某字段排序,目前支持按 timestamp 字段排序。timestamp asc :按字段升序排序;timestamp desc :按字段倒序排序;默认为 timestamp asc 。 |
interval | Query | 可选 | Integer | 该参数仅对标准数据有效,当 boundaryType=sample 时,指定插补数据的时间间隔,默认值为 60,单位为秒。 |
boundaryType | Query | 可选 | String | 该参数仅对标准数据有效。若测点已配置数据压缩存储,指定查询的测点数据类型。可选值为:inside (查询原始压缩数据,此为默认值)、outside (查询原始压缩数据+返回起止时间边界前后的数据)、interpolated (查询原始压缩数据+返回起止时间边界插值数据,即插补起止时间点的数据)、sample (返回起止时间内,按指定时间间隔和算法插补的数据)。插补的数据可按业务需要用于补全 TSDB 中的数据。 |
interpolation | Query | 可选 | String | 该参数仅对标准数据有效,当 boundaryType=sample 时,指定插补数据的算法。可选值为:linear (线性填充值,此为默认值)、previous (之前的一个值)、near (临近的一个值)、after (之后的一个值)。有关插值算法的详细信息,参见 数据插值算法参考说明>> |
type | Query | 可选 | String | 指定查询测点数据的存储类型。可选值为:ai (仅查询AI原始数据)、ai_normalized (仅查询AI分钟级归一化数据)、di (仅查询DI数据)、pi (仅查询PI数据)、generic (仅查询通用数据)。若不指定查询的数据存储类型,则默认从AI原始数据、DI数据、PI数据和通用数据类型中查询测点数据。 |
响应参数 ¶
名称 | 数据类型 | 描述 |
---|---|---|
data | List<JSONObject> | 资产数据列表。单设备单点的返回数据按时间升序排列。详见 items |
items¶
示例¶
{
"assetId": "yourAssetId",
"timestamp": 1560249312446,
"yourPointId": 1.1236,
"localtime": "2019-06-11 18:35:12",
"quality": null
}
参数¶
名称 | 数据类型 | 描述 |
---|---|---|
assetId | String | 资产 ID。 |
timestamp | Long | 数据时间戳,UNIX 时间,精确到秒。 |
pointId | Double | 此参数是变量,在返回数据中显示为传入测点的标识符与查询到的测点数据。 |
localtime | String | 数据本地时间标记,精确到秒,返回结果是否包含设备时区信息,由 localTimeFormat 参数指定。 |
quality | Integer | 数据质量位。 |
示例 1¶
请求示例¶
Local时间格式:
url: https://{apigw-address}/tsdb-service/v2.0/unified-raw?orgId=yourOrgId&modelId=&assetIds=yourAssetIds&pointIds=yourPointIds&startTime=2022-07-12%2015:50:00&endTime=2022-07-12%2016:10:00&pageSize=10&localTimeFormat=1
method: GET
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": "",
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1657612200000,
"yourPointId": 1.1236,
"localtime": "2022-07-12T15:50:00.000+08:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1657612800000,
"yourUnformattedPointId": "sfa",
"localtime": "2022-07-12T16:00:00.000+08:00"
}
]
}
}
示例 2¶
请求示例¶
UTC时间格式:
url: https://{apigw-address}/tsdb-service/v2.0/unified-raw?orgId=yourOrgId&modelId=&assetIds=yourAssetIds&pointIds=yourPointIds&startTime=2022-07-12T15:50:00%2B08:00&endTime=2022-07-12T16:10:00%2B08:00&pageSize=10&localTimeFormat=0
method: GET
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": "",
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1657612200000,
"yourPointId": 1.1236,
"localtime": "2022-07-12 15:50:00.000"
},
{
"assetId": "yourAssetId",
"timestamp": 1657612800000,
"yourUnformattedPointId": "sfa",
"localtime": "2022-07-12 16:00:00.000"
}
]
}
}