Get Asset Current Day Electric Power¶
获取指定设备从本地时间0点开始到当前时间已累计的当日电量数据。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
资产 |
Read |
有关各资源及其对应的权限,参考 策略,角色,与权限>>
请求格式¶
POST https://{apigw-address}/tsdb-service/v2.1/electric-power/current-day
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
modelId |
可选 |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
必需 |
String |
资产ID,支持查询多个资产,多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
pointIds |
必需 |
String |
资产测点,支持多测点查询,各个测点间用逗号隔开。如何获取pointId信息>> |
localTimeAccuracy |
可选 |
Boolean |
指定查询结果是否包含毫秒级结果。 |
localTimeFormat |
可选 |
Integer |
指定返回数据的local时间是否包含设备时区信息。0:不包含设备时区信息;1:包含设备时区信息;默认值为0。 |
itemFormat |
可选 |
Integer |
指定返回结果中测点数据的显示格式。可选值为0,1,2,默认值为0。对每种显示格式的详细介绍,参见 Item Format 示例>> |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
List<JSONObject> |
资产数据列表。单设备单点的返回数据按时间升序排列。详见 items |
items¶
示例¶
{
"assetId": "yourAssetId",
"timestamp": 1590076800000,
"sum(yourPointId)": 10.615000000000002,
"localtime": "2020-05-22 00:00:00"
}
参数¶
名称 |
数据类型 |
描述 |
---|---|---|
assetId |
String |
资产ID。 |
timestamp |
Long |
数据时间戳,UNIX时间,精确到秒。 |
sum(pointId) |
Double |
此参数是变量,在返回数据中显示为传入测点的标识符与查询到的测点数据。此处数据是电量PI的当天sum聚合。 |
localtime |
String |
返回数据的本地时间。 |
错误码¶
有关错误码的描述,参见 通用错误码。
示例¶
请求示例¶
url: https://{apigw-address}/tsdb-service/v2.1/electric-power/current-day?orgId=yourOrgId
method: POST
Content-Type: application/json
requestBody:
{
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"localTimeAccuracy": true,
"localTimeFormat": 1,
"itemFormat": 0
}
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"items": [
{
"assetId": "yourAssetId",
"timestamp": 1590076800000,
"sum(yourPointId)": 10.615000000000002,
"localtime": "2020-05-22 00:00:00"
}
]
}
}
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 GetAssetCurrentDayElectricPower {
private static final String API_Gateway_URL = "https://{apigw-address}";
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;
}
}
public static void main(String[] args) {
//1.在EnOS管理门户的左边导航栏中点击应用注册。
//2.点击需调用API的应用,查看基本信息中的AccessKey和SecretKey
Poseidon poseidon = Poseidon.config(
PConfig.init()
.appKey("AccessKey of your APP")
.appSecret("SecretKey of your APP")
).method("POST").header("Content-Type", "application/json");
Request request = new Request();
request.setBodyParams("assetIds", "yourAssetId1,yourAssetId2");
request.setBodyParams("pointIds", "yourPointIds");
request.setBodyParams("localTimeAccuracy", true);
request.setBodyParams("localTimeFormat", 1);
request.setBodyParams("itemFormat", 0);
request.setMethod("POST");
JSONObject response = poseidon
.url(API_Gateway_URL + "/tsdb-service/v2.1/electric-power/current-day")
.queryParam("orgId", "yourOrgId")
.getResponse(request, JSONObject.class);
System.out.println(response);
}
}