Get Asset Unified Raw Data¶
用于查询 标准数据 + 非标准数据 的统一接口。支持标准数据的插补(插补的参数 boundaryType
、interval
和interpolation
只作用于标准数据)。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
资产 |
Read |
有关各资源及其对应的权限,参考 策略,角色,与权限>>
请求格式¶
POST https://{apigw-address}/tsdb-service/v2.1/unified-raw
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
modelId |
可选 |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
必需 |
String |
资产ID,支持查询多个资产,多个资产 ID 之间用英文逗号隔开。如何获取Asset ID信息>> |
pointIds |
必需 |
String |
资产测点,支持多测点查询,包括标准测点和非标准测点,多个测点 ID 之间用英文逗号隔开。设备数量 * 测点数量 <= 3000。如何获取pointId信息>> |
startTime |
必需 |
String |
采样数据开始时间,支持local时间和UTC时间。local时间的格式为 |
endTime |
必需 |
String |
采样数据结束时间,格式必须与开始时间保持一致。 |
pageSize |
可选 |
Integer |
单次查询返回记录条数的上限,默认值为 1000。返回总数据量遵循约束:(设备数量 * 测点数量 * pagesize)≤ 640000。 |
localTimeAccuracy |
可选 |
Boolean |
指定查询结果是否包含毫秒级结果。 |
localTimeFormat |
可选 |
Integer |
指定返回数据的local时间是否包含设备时区信息。0:不包含设备时区信息;1:包含设备时区信息;默认值为 0。 |
itemFormat |
可选 |
Integer |
指定返回结果中测点数据的显示格式。可选值为:0、1、2,默认值为 0。对每种显示格式的详细介绍,参见 Item Format 示例>> |
withQuality |
可选 |
Boolean |
该参数仅对标准数据有效。指定返回结果中是否包含数据质量位, |
orderBy |
可选 |
String |
指定返回结果按照某字段排序,目前支持按 |
boundaryType |
可选 |
String |
该参数仅对标准数据有效。若测点已配置数据压缩存储,指定查询的测点数据类型。可选值为: |
interval |
可选 |
Integer |
该参数仅对标准数据有效,当 |
interpolation |
可选 |
String |
该参数仅对标准数据有效,当 |
type |
可选 |
String |
指定查询测点数据的存储类型。可选值为: |
响应参数 ¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
List<JSONObject> |
资产数据列表。单设备单点的返回数据按时间升序排列。详见 items |
items¶
示例¶
{
"assetId": "yourAssetId",
"yourPointId": 1,
"timestamp": 1657612800000,
"localtime": "2022-07-12T16:00:00.000+08:00",
"quality": null
}
参数¶
名称 |
数据类型 |
描述 |
---|---|---|
assetId |
String |
资产 ID。 |
timestamp |
Long |
数据时间戳,UNIX 时间,精确到秒。 |
pointId |
Double |
此参数是变量,在返回数据中显示为传入测点的标识符与查询到的测点数据。 |
localtime |
String |
数据本地时间标记,精确到秒,返回结果是否包含设备时区信息,由 localTimeFormat 参数指定。 |
quality |
Integer |
数据质量位。 |
错误码¶
有关错误码的描述,参见 通用错误码。
示例 1¶
请求示例¶
Local时间格式:
url: https://{apigw-address}/tsdb-service/v2.1/unified-raw?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointId,yourUnformattedPointId",
"startTime": "2022-07-12 15:50:00",
"endTime": "2022-07-12 16:10:00",
"pageSize": 10,
"localTimeAccuracy": true,
"localTimeFormat": 1,
"itemFormat": 0,
"orderBy": "timestamp asc"
}
返回示例¶
{
"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.1/unified-raw?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointId,yourUnformattedPointId",
"startTime": "2022-07-12T15:50:00+08:00",
"endTime": "2022-07-12T16:10:00+08:00",
"pageSize": 10,
"localTimeAccuracy": false,
"localTimeFormat": 0,
"itemFormat": 0,
"orderBy": "timestamp asc"
}
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": "",
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1657612200000,
"yourPointId": 1.1236,
"localtime": "2022-07-12 15:50:00"
},
{
"assetId": "yourAssetId",
"timestamp": 1657612800000,
"yourUnformattedPointId": "sfa",
"localtime": "2022-07-12 16:00:00"
}
]
}
}
SDK 示例¶
你可以在 Github 上获取 TSDB 数据服务的 Java SDK 示例。