Get Asset AI Data with Aggregation Logic¶

Get the AI normalized data of specified measurement points of specified devices within a certain period. The queried data can also be aggregated by the specified logic.

Operation Permissions¶

Required Authorization	Required Operation Permission
Asset	Read

For more information about resources and required permission, see Policies, Roles and Permissions>>

Using GET Method¶

Request Format¶

GET https://{apigw-address}/tsdb-service/v2.0/ai-normalized

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get organization ID>>
modelId	Query	Optional	String	The model ID. How to get model ID>>
assetIds	Query	Mandatory	String	The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>>
measurepointsWithLogic	Query	Mandatory	String	The aggregation logic with the measurement point ID. The supported aggregation calculation methods include count, avg, sum, max, min, first, and last. The time range for the aggregation query is (startTime, endTime), that is, the aggregation operand contains the data at the time of `startTime`, but does not contain the data at the time of `endTime`. The upper limit of the number of measurement points that can be queried is 3,000. Format: `Function(pointId)`, e.g. `sum(pointId)`. How to get measurement point ID>>
interval	Query	Mandatory	Integer	The time interval for the aggregation algorithm to work. The range is 0-1440, calculated in minutes. If the interval value is 0, the measurement point has no aggregation logic; if the interval value is greater than 0, the measurement point must have the aggregation logic.
startTime	Query	Mandatory	String	The start time of the sampling data, where both UTC and local time formats are supported. For UTC time format, the application will query all the asset data by the unified start timestamp and end timestamp. Timezone information is required for the UTC time format: 2019-06-01T00:00:00+08:00. For local time format, the application will query the asset data by the local time of where the device is located. Its format is: YYYY-MM-DD HH:MM:SS.
endTime	Query	Mandatory	String	The end time of the sampling data. Its format must be consistent with `startTime`.
pageSize	Query	Optional	Integer	The upper limit of the returned records in a single page for a single measurement point of a single device, which is 1,000 by default. For a single query, the total returned data amount follows the constraint: (Number of devices * Number of points * pagesize) ≤ 640,000.
accessKey	Query	Optional	String	The service account for authentication purposes. How to get the accessKey>>
localTimeAccuracy	Query	Optional	Boolean	true = query returns data with millisecond time stamp false (default) = query returns data without millisecond time stamp

Response Parameters ¶

Name	Data Type	Description
data	List<JSONObject>	The list of asset data. The data returned for a single point of a single device is sorted by the data timestamp in ascending order. For more information, see items

items¶

Sample¶

{
    "sum(opentsdb_ai_point)": 4.4944,
    "assetId": "4DXYH7nS",
    "timestamp": 1560249300000,
    "localtime": "2019-06-11 18:35:00"
}

Parameters¶

Name	Data Type	Description
pointIdWithLogic	Double	This parameter is a variable, representing the identifier and data of the measurement point (with or without aggregation logic)
assetId	String	The asset ID.
timestamp	Long	The data timestamp (UNIX time, accurate to the second).
localtime	String	The data timestamp in local time format (accurate to the second). If UTC time format is used when specifying the `statTime` and `endtime`, this value will be null.

Error Codes¶

For description of error codes, see Common Error Codes.

Sample 1 (GET Method)¶

Request Sample¶

Local time format:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized?orgId=yourOrgId&modelId=&assetIds=4DXYH7nS&measurepointsWithLogic=sum(opentsdb_ai_point)&interval=10&startTime=2019-06-01%2000:00:00&endTime=2019-06-11%2023:00:00&pageSize=&accessKey=accessKey

method: GET

Return Sample¶

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "sum(opentsdb_ai_point)": 4.4944,
        "assetId": "4DXYH7nS",
        "timestamp": 1560249300000,
        "localtime": "6/11/2019 6:35:00 PM"
      },
      {
        "sum(opentsdb_ai_point)": 6.0,
        "assetId": "4DXYH7nS",
        "timestamp": 1560257100000,
        "localtime": "6/11/2019 8:45:00 PM"
      }
    ]
  }
}

Sample 2 (GET Method)¶

Request Sample¶

UTC time format:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized?accessKey=accessKey&assetIds=4DXYH7nS&pageSize=5000&interval=10&startTime=2019-06-01T00:00:00%2B08:00&endTime=2019-06-11T23:00:00%2B08:00&orgId=yourOrgId&measurepointsWithLogic=sum(opentsdb_ai_point)
method: GET

Return Sample¶

{
    "status": 0,
    "requestId": null,
    "msg": "success",
    "submsg": null,
    "data": {
        "items": [
            {
                "localtime": null,
                "sum(opentsdb_ai_point)": 4.4944,
                "assetId": "4DXYH7nS",
                "timestamp": 1560249300000
            },
            {
                "localtime": null,
                "sum(opentsdb_ai_point)": 6.0,
                "assetId": "4DXYH7nS",
                "timestamp": 1560257100000
            }
        ]
    }
}

Java SDK Sample¶

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;
import org.junit.Test;

public class GetMethod {

    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 GetAssetAINormalizedDataTest(){

        //1. Click Application Registration in the left navigation of the EnOS Management Console.
        //2. Click the application that needs to call the API, and click Basic Information. accessKey and secretKey correspond to AccessKey and SecretKey in EnOS.
        String accessKey = "yourAccessKey";
        String secretKey = "yourSecretKey";

        //Create a request and pass the required parameters into the map that exists in the query. The key is the parameter name and the value is the parameter value.
        Request request = new Request();
        request.setQueryParam("orgId", "yourOrgId");
        request.setQueryParam("modelId", "opentsdb_model");
        request.setQueryParam("assetIds","4DXYH7nS");
        request.setQueryParam("measurepointsWithLogic", "sum(opentsdb_ai_point)");
        request.setQueryParam("interval", 10);
        request.setQueryParam("startTime", "2019-06-01 00:00:00"); //For UTC time format: 2019-06-01T00:00:00+08:00
        request.setQueryParam("endTime", "2019-06-11 23:00:00");   //For UTC time format: 2019-06-11T23:00:00+08:00
        request.setQueryParam("pageSize", 10);

        request.setMethod("GET");

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

Using POST Method¶

Request Format¶

POST https://{apigw-address}/tsdb-service/v2.0/ai-normalized

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
orgId	Mandatory	String	The organization ID which the asset belongs to. How to get organization ID>>
modelId	Optional	String	The model ID. How to get model ID>>
assetIds	Mandatory	String	The asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>>
measurepointsWithLogic	Mandatory	String	The aggregation logic with measurement point ID. The supported aggregation calculation methods include count, avg, sum, max, min, first, and last. The time range for the aggregation query is (startTime, endTime), that is, the aggregation operand contains the data at the time of `startTime`, but does not contain the data at the time of `endTime`. The upper limit of the number of measurement points that can be queried is 3,000. Format: `Function(pointId)`, e.g. `sum(pointId)`. How to get measurement point ID>>
interval	Mandatory	Integer	The time interval for the aggregation algorithm to work. The range is 0-1440, calculated in minutes. If the interval value is 0, the measurement point has no aggregation logic; if the interval value is greater than 0, the measurement point must have the aggregation logic.
startTime	Mandatory	String	The start time of the sampling data, where both UTC and local time formats are supported. For UTC time format, the application will query all the asset data by the unified start timestamp and end timestamp. Timezone information is required for the UTC time format: 2019-06-01T00:00:00+08:00. For local time format, the application will query the asset data by the local time of where the device is located. Its format is: YYYY-MM-DD HH:MM:SS.
endTime	Mandatory	String	The end time of the sampling data. Its format must be consistent with `startTime`.
pageSize	Optional	Integer	The upper limit of the returned records in a single page for a single measurement point of a single device, which is 1,000 by default. For a single query, the total returned data amount follows the constraint: (Number of devices * Number of points * pagesize) ≤ 640,000.
accessKey	Optional	String	The service account for authentication purposes. How to get the accessKey>>
localTimeAccuracy	Optional	Boolean	true = query returns data with millisecond time stamp false (default) = query returns data without millisecond time stamp

Response Parameters¶

See description in Response Parameters of the Using GET Method section.

Error Codes¶

For description of error codes, see Common Error Codes.

Sample 1 (POST Method)¶

Request Sample¶

Local time format:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized

method: POST

Content-Type: multipart/form-data;charset=UTF-8

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "4DXYH7nS",
  "measurepointsWithLogic": "sum(opentsdb_ai_point)",
  "startTime": "2020-04-20 00:00:00",
  "endTime": "2020-04-21 00:00:00",
  "interval": 10,
  "pageSize": 10,
  "accessKey": "accessKey"
}

Return Sample¶

{
  "status": 0,
  "requestId": null,
  "msg": "success",
  "submsg": null,
  "data": {
    "items": [
      {
        "sum(opentsdb_ai_point)": 4.4944,
        "assetId": "4DXYH7nS",
        "timestamp": 1560249300000,
        "localtime": "6/11/2019 6:35:00 PM"
      },
      {
        "sum(opentsdb_ai_point)": 6.0,
        "assetId": "4DXYH7nS",
        "timestamp": 1560257100000,
        "localtime": "6/11/2019 8:45:00 PM"
      }
    ]
  }
}

Sample 2 (POST Method)¶

Request Sample¶

UTC time format:

url: https://{apigw-address}/tsdb-service/v2.0/ai-normalized

method: POST

Content-Type: multipart/form-data;charset=UTF-8

requestBody:
{
  "orgId": "yourOrgId",
  "assetIds": "4DXYH7nS",
  "measurepointsWithLogic": "sum(opentsdb_ai_point)",
  "startTime": "2019-06-01T00:00:00%2B08:00",
  "endTime": "2019-06-11T23:00:00%2B08:00",
  "interval": 10,
  "pageSize": 10,
  "accessKey": "accessKey"
}

Return Sample¶

{
    "status": 0,
    "requestId": null,
    "msg": "success",
    "submsg": null,
    "data": {
        "items": [
            {
                "localtime": null,
                "sum(opentsdb_ai_point)": 4.4944,
                "assetId": "4DXYH7nS",
                "timestamp": 1560249300000
            },
            {
                "localtime": null,
                "sum(opentsdb_ai_point)": 6.0,
                "assetId": "4DXYH7nS",
                "timestamp": 1560257100000
            }
        ]
    }
}

Java SDK Sample¶

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;
import org.junit.Test;

public class PostMethod {

    private static class Request extends PoseidonRequest {

        public void setFormParam(String key, String value){
            formParams().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 GetAssetAINormalizedDataTest(){

        //1. Click Application Registration in the left navigation of the EnOS Management Console.
        //2. Click the application that needs to call the API, and click Basic Information. accessKey and secretKey correspond to AccessKey and SecretKey in EnOS.
        String accessKey = "yourAccessKey";
        String secretKey = "yourSecretKey";

        //Create a request and pass the required parameters into the map that exists in the form. The key is the parameter name and the value is the parameter value.
        Request request = new Request();
        request.setFormParam("orgId", "yourOrgId");
        request.setFormParam("modelId", "opentsdb_model");
        request.setFormParam("assetIds", "4DXYH7nS");
        request.setFormParam("measurepointsWithLogic", "sum(opentsdb_ai_point)");
        request.setFormParam("interval", "10");
        request.setFormParam("startTime", "2019-06-01 00:00:00"); //For UTC time format: 2019-06-01T00:00:00+08:00
        request.setFormParam("endTime", "2019-06-11 23:00:00");   //For UTC time format: 2019-06-11T23:00:00+08:00
        request.setFormParam("pageSize", "10");

        request.setMethod("POST");

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