Filter Asset Latest Data¶
过滤查询多个设备单个测点的最新数据。支持查询的数据类型为Numeric和String。
请求格式¶
http://{apigw-address}/tsdb-service/v2.0/latest/filter?orgId={}&modelId={}&assetIds={}&measurepoint={}&operator={}&valueFilter={}&accessKey={}&timeWindow={}
请求参数(URI)¶
名称 |
位置(Path/Query) |
是否必须 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
true |
String |
资产所属的组织ID。如何获取orgId信息>> |
modelId |
Query |
true |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
Query |
true |
String |
资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
measurepoint |
Query |
true |
String |
资产测点。如何获取测点(pointId)信息>> |
operator |
Query |
true |
String |
运算符,支持eq:等于;nq:不等于;gt:大于;lt:小于;ge:大于等于;le:小于等于;between:2个值的区间;in:属于多个值之一。 |
valueFilter |
Query |
true |
String |
范围值,需与运算符配套使用,eq、nq、gt、ge、lt、le对应单值;between对应2个值;in对应多个值,多个值之间用逗号隔开,且数据类型必须与测点数据类型一致。如:operator=betwteen&valueFilter=a, b表示过滤a与b之间的数值。 |
accessKey |
Query |
false |
String |
应用的服务账号,应用以 |
timeWindow |
Query |
false |
Integer |
返回数据时间窗口设定,单位是分钟,最小值为0,不传则不过滤。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
items |
|
资产数据列表。单设备单点的返回数据按时间升序排列。其中的Object结构体中存储着参数,详见items。 |
items¶
例子:
{
"assetId": "FGqRJKPM", //资产ID
"pointId": 1.5, //测点标识符与测点数据
"timestamp": 1559570160000 //UNIX数据时间戳
}
名称 |
数据类型 |
描述 |
---|---|---|
assetId |
Object |
资产ID |
pointId |
Object |
此参数是变量,表示测点的标识符与数据 |
timestamp |
Object |
数据时间戳,UNIX时间,精确到秒 |
错误码¶
有关错误码的描述,参见通用错误码。
示例 1¶
请求示例¶
http://{apigw-address}/tsdb-service/v2.0/latest/filter?orgId=o15528761854851&assetIds=FGqRJKPM&modelId=model_xxx&measurepoint=pointId&timeWindow=&operator=le&valueFilter=55673.9&accessKey=accessKey
其中operator=le&valueFilter=55673.9
的含义:以下示例将过滤出模型model_xxx
的pointId
数据点小于等于55673.9的值。
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"assetId": "FGqRJKPM",
"pointId": 1.5,
"timestamp": 1559570160000
}
]
}
}
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 filterAssetsLatestDataTest(){
//1.在EnOS Console的左边导航栏中点击应用注册。
//2.点击需调用API的应用,查看基本信息中的AccessKey即为appKey、SecretKey即为appSecret
String accessKey = "29b8d283-dddd-4c31f0e3a356-0f80-4fdf";
String secretKey = "f0e3a856-0fc0-4fdf-b1e5-b34da152879c";
//新建一个request 然后把需要的参数传进去存在query的map中,key是参数名字,value是参数值
Request request = new Request();
request.setQueryParam("orgId", "o15504745674071");
request.setQueryParam("timeWindow", 10);
request.setQueryParam("operator", "le");
request.setQueryParam("modelId", "model_xxx");
request.setQueryParam("valueFilter", 666.6);
request.setQueryParam("assetIds","4DXYH7nS");
request.setQueryParam("measurepoint", "opentsdb_pi_point_xxx");
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/latest/filter")
.getResponse(request, JSONObject.class);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}