Get Asset Raw Data by Time Range

获取指定设备的指定测点在某段时间内原始数据的值(包括AI、DI、和通用数据类型)并进行应用开发。

请求格式

http://{apigw-address}/tsdb-service/v2.0/raw?orgId={}&modelId={}&assetIds={}&measurepoints={}&startTime={}&endTime={}&pageSize={}&accessKey={}&localTimeAccuracy={}

请求参数(URI)

名称

位置(Path/Query)

是否必须

数据类型

描述

orgId

Query

true

String

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

modelId

Query

false

String

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

assetIds

Query

true

String

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

measurepoints

Query

true

String

资产测点,支持多测点查询,各个测点间用逗号隔开;支持查询的(设备数*测点数)上限为3000。如何获取测点(pointId)信息>>

startTime

Query

true

String

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

endTime

Query

true

String

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

pageSize

Query

false

Integer

单设备单测点单页返回记录条数的上限,默认为1000。对于单次查询,返回总数据量遵循约束: (设备数 * 点数 * pagesize)≤ 640000。

accessKey

Query

false

String

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

withQuality

Query

false

Boolean

标识返回结果中是否包含数据质量位,true为包含,反之则不包含。

localTimeAccuracy

Query

false

Boolean

查询结果是否包含毫秒级结果。

响应参数

名称

数据类型

描述

items

List<Object>

资产数据列表。单设备单点的返回数据按时间升序排列。其中的Object结构体中存储着参数,详见items

items

例子:

{
        "assetId": "4DXYH7nS",               //资产ID
        "timestamp": 1560249312446,          //数据时间戳
        "opentsdb_ai_point_xxx": "1.1236",   //测点标识符与测点数据
        "localtime": "2019-06-11 18:35:12"   //数据本地时间标记
}

名称

数据类型

描述

localtime

Object

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

assetId

Object

资产ID

pointId

Object

此参数是变量,表示测点的标识符与数据。

timestamp

Object

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

错误码

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

示例 1

请求示例

Local时间格式:

http://{apigw-address}/tsdb-service/v2.0/raw?orgId=o15504722874071&modelId=&assetIds=4DXYH7nS&measurepoints=opentsdb_ai_point_xxx&startTime=2019-05-26%2010:00:00&endTime=2019-06-28%2023:00:00&pageSize=&accessKey=accessKey

返回示例

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "4DXYH7nS",
        "timestamp": 1560249312446,
        "opentsdb_ai_point_xxx": "1.1236",
        "localtime": "2019-06-11 18:35:12"
      },
      {
        "localtime": null,
        "opentsdb_di": "0",
        "assetId": "4DXYH7nS",
        "timestamp": 1560329369735
      }
    ]
  }
}

示例 2

请求示例

UTC时间格式:

http://{apigw-address}/tsdb-service/v2.0/raw?orgId=o15504722874071&accessKey=accessKey&modelId=opentsdb_model&assetIds=4DXYH7nS&measurepoints=opentsdb_di_point_xxx,opentsdb_ai_point_xxx,opentsdb_generic_point_xxx&startTime=2019-06-01T00:00:00%2B08:00&endTime=2019-06-11T23:00:00%2B08:00&pageSize=100

返回示例

{
    "status": 0,
    "requestId": "f1ebd301ff7a4b7f8d53bcfe39ef264e",
    "msg": "success",
    "submsg": null,
    "data": {
        "data": [
            {
                "localtime": null,
                "assetId": "4DXYH7nS",
                "opentsdb_ai_point_xxx": "1.1236",
                "timestamp": 1560249312446
            },
            {
                "localtime": null,
                "opentsdb_di_point_xxx": "0",
                "assetId": "4DXYH7nS",
                "timestamp": 1560329369735
            }
        ]
    }
}

示例 3

请求示例

带数据质量位的查询:

http://{apigw-address}/tsdb-service/v2.0/raw?orgId=o15504722874071&modelId=&assetIds=4DXYH7nS&measurepoints=opentsdb_ai_point_xxx&startTime=2019-05-26%2010:00:00&endTime=2019-06-28%2023:00:00&pageSize=&accessKey=accessKey&withQuality=true

返回示例

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "assetId": "4DXYH7nS",
        "timestamp": 1560249312446,
        "opentsdb_ai_point_xxx": "1.1236",
        "localtime": "2019-06-11 18:35:12",
        "quality": "0"
      },
      {
        "localtime": null,
        "opentsdb_di": "0",
        "assetId": "4DXYH7nS",
        "timestamp": 1560329369735,
        "quality": "0"
      }
    ]
  }
}

Java SDK调用示例

private static class Request extends PoseidonRequest{

    public void setQueryParam(String key, Object value){
        queryEncodeParams().put(key, value);
    }

    public void setMethod(String method) {
        this.method = method;
    }

    private String method;

    @Override
    public String baseUri() {
        return "";
    }

    @Override
    public String method() {
        return method;
    }
}


@Test
public void getAssetsRawDataByTimeRangeTest(){

    //accessKey and secretKey correspond to AccessKey and SecretKey in EnOS
    String accessKey = "29b8d283-dddd-4c31f0e3a356-0f80-4fdf";
    String secretKey = "f0e3a856-0fc0-4fdf-b1e5-b34da152879c";

    // Create a new request and pass the required parameters into the Query map.
    // The key is the parameter name and the value is the parameter value.
    Request request = new Request();
    request.setQueryParam("orgId", "o15504745674071");
    request.setQueryParam("modelId", "opentsdb_model_xxx");
    request.setQueryParam("assetIds","4DXYH7nS");
    request.setQueryParam("measurepoints", "opentsdb_di_point_xxx,opentsdb_ai_point_xxx,opentsdb_generic_point_xxx");
    request.setQueryParam("startTime", "2019-06-01 00:00:00"); //or in UTC format:2019-06-01T00:00:00+08:00
    request.setQueryParam("endTime", "2019-06-11 23:00:00");  //or in UTC format:2019-06-11T00:00:00+08:00
    request.setQueryParam("pageSize" , 10);
    request.setQueryParam("accessKey", accessKey);

    request.setMethod("GET");

    try {
        JSONObject response =  Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                .url("http://apim-gateway/tsdb-service/v2.0/raw")
                .getResponse(request, JSONObject.class);
        System.out.println(response);
    } catch (Exception e) {
        e.printStackTrace();
    }
}