Filter Asset Latest Data¶

过滤查询多个设备单个测点的最新数据。支持过滤查询数值型的数据。

操作权限¶

需授权的资源	所需操作权限
资产	Read

有关各资源及其对应的权限，参考策略，角色，与权限>>

请求格式¶

POST https://{apigw-address}/tsdb-service/v2.1/latest/filter

请求参数（URI）¶

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

请求参数（Body）¶

名称	必需/可选	数据类型	描述
modelId	必需	String	资产所属模型ID。如何获取modelId信息>>
assetIds	必需	String	资产ID，支持查询多个资产，多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>>
pointId	必需	String	资产测点，支持多测点查询，各个测点间用英文逗号隔开；支持查询的（设备数*测点数）上限为3000。如何获取pointId信息>>
operator	必需	String	运算符，支持eq：等于；nq：不等于；gt：大于；lt：小于；ge：大于等于；le：小于等于；between：2个值的区间；in：属于多个值之一。
valueFilter	必需	String	范围值，需与运算符配套使用，eq、nq、gt、ge、lt、le对应单值；between对应2个值；in对应多个值，多个值之间用逗号隔开，且数据类型必须与测点数据类型一致。如：operator=betwteen&valueFilter=a, b表示过滤a与b之间的数值。
timeWindow	可选	Integer	返回数据时间窗口设定，单位是分钟，最小值为0，不传则不过滤。
ifWithLocalTime	可选	Boolean	指定查询结果是否需要返回数据的local时间。`true` 表示查询结果包含数据的local时间，`false` 表示查询结果不包含数据的local时间。
localTimeAccuracy	可选	Boolean	指定返回数据的local时间是否需要毫秒格式。`true` 表示返回的local时间需要毫秒格式，`false` 表示返回的local时间不需要毫秒格式。
localTimeFormat	可选	Integer	指定返回数据的local时间是否包含设备时区信息。0：不包含设备时区信息；1：包含设备时区信息；默认值为0。
itemFormat	可选	Integer	指定返回结果中测点数据的显示格式。可选值为0，1，2，默认值为0。对每种显示格式的详细介绍，参见 Item Format 示例>>

响应参数¶

名称	数据类型	描述
data	List<JSONObject>	资产数据列表。单设备单点的返回数据按时间升序排列。详见 items

items¶

示例¶

{
    "localtime":"2020-03-31T23:59:59+08:00",
    "assetId": "Ps4PViva",
    "pointId": 1.5,
    "timestamp": 1585670399000
}

参数¶

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

错误码¶

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

示例¶

请求示例¶

url: https://{apigw-address}/tsdb-service/v2.1/latest/filter?orgId=yourOrgId

method: POST

Content-Type: application/json

requestBody:
{
  "modelId": "export_data",
  "assetIds": "Ps4PViva",
  "pointId": "pi_point",
  "operator": "le",
  "valueFilter": "100",
  "timeWindow": "",
  "ifWithLocalTime": "true",
  "localTimeAccuracy": "false",
  "localTimeFormat": 1,
  "itemFormat": 0
}

其中operator:le,valueFilter:100的含义：以上示例将过滤出模型export_data的pi_point数据点小于等于100的值。

返回示例¶

{
  "code": 0,
  "msg": "OK",
  "submsg": null,
  "data": {
    "items": [
      {
        "localtime":"2020-03-31T23:59:59+08:00",
        "assetId": "Ps4PViva",
        "pi_point": 1.5,
        "timestamp": 1585670399000
      }
    ]
  }
}

Java SDK调用示例¶

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.Before;
import org.junit.Test;

public class Sample {
    private static final String API_Gateway_URL = "https://{domain_url}";
    private Poseidon poseidon;

    private static class Request extends PoseidonRequest {

        public void setBodyParams(String key, Object value) {
            bodyParams().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;
        }
    }

    @Before
    public void init() {
        poseidon = Poseidon.config(
                PConfig.init()
                        .appKey("AccessKey of your APP")
                        .appSecret("SecretKey of your APP")
        ).method("POST").header("Content-Type", "application/json");
    }

    @Test
    public void FilterAssetLatestData() {
        Request request = new Request();
        request.setBodyParams("modelId", "yourModelId");
        request.setBodyParams("assetIds", "yourAssetId1,yourAssetId2");
        request.setBodyParams("pointId", "yourPointId");
        request.setBodyParams("operator", "gt");
        request.setBodyParams("valueFilter", "1000");
        request.setBodyParams("ifWithLocalTime", true);
        request.setBodyParams("localTimeAccuracy", false);
        request.setBodyParams("localTimeFormat", 1);
        request.setBodyParams("itemFormat", 0);

        JSONObject response =  poseidon
                .url(API_Gateway_URL + "/tsdb-service/v2.1/latest/filter")
                .queryParam("orgId", "yourOrgId")
                .getResponse(request, JSONObject.class);
        System.out.println(response);
    }
}