• 文档
• Get Asset Unified Raw Data

Get Asset Unified Raw Data

用于查询 标准数据 + 非标准数据 的统一接口。支持标准数据的插补（插补的参数 boundaryType、interval 和 interpolation 只作用于标准数据）。

请求格式

POST https://{apigw-address}/tsdb-service/v2.1/unified-raw

请求参数（URI）

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	资产所属的 OU ID。如何获取 orgId 信息 >>

请求参数（Body）

名称	必需/可选	数据类型	描述
modelId	可选	String	资产所属模型 ID。如何获取 modelId 信息 >>
assetIds	必需	String	资产 ID，支持查询多个资产，多个资产 ID 之间用英文逗号隔开。如何获取 Asset ID 信息 >>
pointIds	必需	String	资产测点，支持多测点查询，包括标准测点和非标准测点，多个测点 ID 之间用英文逗号隔开。设备数量 * 测点数量 <= 3000。如何获取 pointId 信息 >>
startTime	必需	String	采样数据开始时间，支持设备当地时间和 UTC 时间。设备当地时间的格式为 YYYY-MM-DD HH:MM:SS。当格式为设备当地时间时，使用设备所在地的当地时间进行查询。UTC 时间格式如 2019-06-01T00:00:00+08:00，+08:00 表示时区。当格式为 UTC 时间时，对所有资产按照统一的开始时间和结束时间进行查询。
endTime	必需	String	采样数据结束时间，格式必须与开始时间保持一致。
pageSize	可选	Integer	单次查询返回记录条数的上限，默认值为 1000。返回总数据量遵循约束:（设备数量 * 测点数量 * pagesize）≤ 640000。
localTimeAccuracy	可选	Boolean	指定查询结果是否包含毫秒级结果。true 表示需要毫秒格式，false 表示不需要毫秒格式。默认值为 false。
localTimeFormat	可选	Integer	指定返回数据当地时间是否包含设备时区信息。0：不包含设备时区信息；1：包含设备时区信息；默认值为 0。
itemFormat	可选	Integer	指定返回结果中测点数据的显示格式。可选值为：0、1、2，默认值为 0。对每种显示格式的详细介绍，参见 Item Format 示例 >>
withQuality	可选	Boolean	该参数仅对标准数据有效。指定返回结果中是否包含数据质量位，true 为包含，false 表示不包含。默认值为 false。
orderBy	可选	String	指定返回结果按照某字段排序，目前支持按 timestamp 字段排序。timestamp asc：按字段升序排序；timestamp desc：按字段倒序排序；默认值为 timestamp asc。
boundaryType	可选	String	该参数仅对标准数据有效。对于已配置数据压缩存储的测点，可指定查询的测点数据类型。可选值为： inside：仅返回原始压缩数据，即时间范围内的数据。若不指定，默认为 inside。 outside：返回原始压缩数据，以及超出起止时间前后边界的数据。 interpolated：返回原始压缩数据，以及起止时间边界插值数据，即插补起止时间点的数据。 sample：返回起止时间内，按指定的时间间隔和算法插补后的数据。插补的数据可用于补全 TSDB 中的数据差距，生成均匀采样的数据序列。
interval	可选	Integer	该参数仅对标准数据有效，当 boundaryType=sample 时，指定插补数据的时间间隔，默认值为 60，单位为秒。
interpolation	可选	String	该参数仅对标准数据有效，当 boundaryType=sample 时，指定插补数据的算法。可选值为： linear：使用线性插值算法来计算缺失的数据点。若不指定，默认为 linear。 previous：用前一个有效数据点的值来填充缺失的数据点。 near：用临近的有效数据点的值来填充缺失的数据点。 after：用后一个有效数据点的值来填充缺失的数据点。 有关插值算法的更多信息，参见 数据插值算法参考说明 >>
type	可选	String	指定查询测点数据的存储类型。可选值为： ai：仅查询 AI 原始数据。 ai_normalized：仅查询 AI 分钟级归一化数据。 di：仅查询 DI 数据。 pi：仅查询 PI 数据。 generic：仅查询通用数据。 若不指定查询的数据存储类型，则默认查询 AI 原始数据、DI 数据、PI 数据和通用类型的测点数据。

响应参数

名称	数据类型	描述
assetId	String	资产 ID。
timestamp	Long	数据时间戳，UNIX 时间，精确到秒。
pointId	Double	此参数的名称是变量，在返回结构中，参数名称为测点的标识符，参数的值为测点数据。
localtime	String	数据本地时间标记，精确到秒，返回结果是否包含设备时区信息，由 localTimeFormat 参数指定。
quality	Integer	数据质量位。

示例 1

示例 1 按照设备当地时间请求数据。

请求示例

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

示例 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 示例。