Filter Asset Latest Data¶
过滤查询多个设备单个测点的最新数据。支持过滤查询数值型的数据。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
资产 |
Read |
有关各资源及其对应的权限,参考 策略,角色,与权限>>
使用GET方法¶
请求格式¶
GET https://{apigw-address}/tsdb-service/v2.0/latest/filter
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
modelId |
Query |
必需 |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
Query |
必需 |
String |
资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
measurepoint |
Query |
必需 |
String |
资产测点ID。如何获取pointId信息>> |
operator |
Query |
必需 |
String |
运算符,支持eq:等于;nq:不等于;gt:大于;lt:小于;ge:大于等于;le:小于等于;between:2个值的区间;in:属于多个值之一。 |
valueFilter |
Query |
必需 |
String |
范围值,需与运算符配套使用,eq、nq、gt、ge、lt、le对应单值;between对应2个值;in对应多个值,多个值之间用逗号隔开,且数据类型必须与测点数据类型一致。如:operator=betwteen&valueFilter=a, b表示过滤a与b之间的数值。 |
accessKey |
Query |
可选 |
String |
应用的服务账号,应用以accessKey进行鉴权以获得其被授权访问的数据。如何获取accessKey信息>> |
timeWindow |
Query |
可选 |
Integer |
返回数据时间窗口设定,单位是分钟,最小值为0,不传则不过滤。 |
ifWithLocalTime |
Query |
可选 |
Boolean |
指定查询结果是否需要返回数据的local时间。 |
localTimeAccuracy |
Query |
可选 |
Boolean |
指定返回数据的local时间是否需要毫秒格式。 |
响应参数 ¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
List<JSONObject> |
资产数据列表。单设备单点的返回数据按时间升序排列。详见 items |
items¶
示例¶
{
"assetId": "yourAssetId",
"yourPointId": 1.5,
"timestamp": 1559570160000
}
参数¶
名称 |
数据类型 |
描述 |
---|---|---|
assetId |
String |
资产ID。 |
pointId |
Double |
此参数是变量,在返回数据中显示为传入测点的标识符与查询到的测点数据。 |
timestamp |
Long |
数据时间戳,UNIX时间,精确到秒。 |
错误码¶
有关错误码的描述,参见 通用错误码。
示例 1¶
请求示例¶
url: https://{apigw-address}/tsdb-service/v2.0/latest/filter?orgId=yourOrgId&assetIds=yourAssetIds&modelId=yourModelId&measurepoint=yourPointId&timeWindow=&operator=le&valueFilter=55673.9&accessKey=accessKeyOfYourAPP
method: GET
其中operator=le&valueFilter=55673.9
的含义:以上示例将过滤出模型opentsdb_model
的pointId
数据点小于等于55673.9的值。
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"yourPointId": 1.5,
"timestamp": 1559570160000
}
]
}
}
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;
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;
}
}
public static void main(String[] args){
//1.在EnOS管理门户的左边导航栏中点击应用注册。
//2.点击需调用API的应用,查看基本信息中的AccessKey和SecretKey
String accessKey = "AccessKey of your APP";
String secretKey = "SecretKey of your APP";
//新建一个request 然后把需要的参数传进去存在query的map中,key是参数名字,value是参数值
Request request = new Request();
request.setQueryParam("orgId", "yourOrgId");
request.setQueryParam("timeWindow", 10);
request.setQueryParam("operator", "le");
request.setQueryParam("modelId", "yourModelId");
request.setQueryParam("valueFilter", 666.6);
request.setQueryParam("assetIds","yourAssetIds");
request.setQueryParam("measurepoint", "yourPointId");
request.setMethod("GET");
try {
JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url("https://{apigw-address}/tsdb-service/v2.0/latest/filter")
.getResponse(request, JSONObject.class);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}
}
使用POST方法¶
请求格式¶
POST https://{apigw-address}/tsdb-service/v2.0/latest/filter
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
orgId |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
modelId |
可选 |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
必需 |
String |
资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
measurepoint |
必需 |
String |
资产测点ID。如何获取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之间的数值。 |
accessKey |
可选 |
String |
应用的服务账号,应用以accessKey进行鉴权以获得其被授权访问的数据。如何获取accessKey信息>> |
timeWindow |
可选 |
Integer |
返回数据时间窗口设定,单位是分钟,最小值为0,不传则不过滤。例如:当 timeWindow=n 时,返回距当前时间 n 分钟内的最后一条数据;当 timeWindow=0 时,如果最新数据时间戳大于当前时间,将返回最新时间戳上的数据。 |
ifWithLocalTime |
可选 |
String |
指定查询结果是否需要返回数据的local时间。 |
localTimeAccuracy |
可选 |
String |
指定返回数据的local时间是否需要毫秒格式。 |
响应参数¶
参见 使用GET方法 中的描述。
错误码¶
有关错误码的描述,参见 通用错误码。
示例 1¶
请求示例¶
url: https://{apigw-address}/tsdb-service/v2.0/latest/filter
method: POST
Content-Type: multipart/form-data;charset=UTF-8
requestBody:
{
"orgId": "yourOrgId",
"modelId": "yourModelId",
"assetIds": "yourAssetIds",
"pointId": "yourPointId",
"operator": "le",
"valueFilter": "55673.9",
"accessKey": "AccessKey of your APP"
}
其中operator:le,valueFilter:55673.9
的含义:以下示例将过滤出模型opentsdb_model
的pointId
数据点小于等于55673.9的值。
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"yourPointId": 1.5,
"timestamp": 1559570160000
}
]
}
}
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;
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;
}
}
public static void main(String[] args){
//1.在EnOS管理门户的左边导航栏中点击应用注册。
//2.点击需调用API的应用,查看基本信息中的AccessKey和SecretKey
String accessKey = "AccessKey of your APP";
String secretKey = "SecretKey of your APP";
//新建一个request 然后把需要的参数传进去存在form的map中,key是参数名字,value是参数值
Request request = new Request();
request.setFormParam("orgId", "yourOrgId");
request.setFormParam("timeWindow", "10");
request.setFormParam("operator", "le");
request.setFormParam("modelId", "yourModelId");
request.setFormParam("valueFilter", "666.6");
request.setFormParam("assetIds","yourAssetIds");
request.setFormParam("measurepoint", "yourPointId");
request.setMethod("POST");
try {
JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url("https://{apigw-address}/tsdb-service/v2.0/latest/filter")
.getResponse(request, JSONObject.class);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}
}