Get Asset Current Day Electric Power¶
Get the accumulated power consumption/production data of specified devices from 00:00 (local time) of the current day.
Operation Permissions¶
Required Authorization | Required Operation Permission |
---|---|
Asset | Read |
For more information about resources and required permission, see Policies, Roles and Permissions>>
Request Format¶
POST https://{apigw-address}/tsdb-service/v2.1/electric-power/current-day
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>> |
Request Parameters (Body)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
modelId | Optional | String | The model ID. How to get model ID>> |
assetIds | Mandatory | String | Asset ID. Supports the query of multiple asset IDs, separated by commas. How to get asset ID>> |
pointIds | Mandatory | String | The measurement point ID. Supports the query of multiple measurement point IDs, separated by commas. How to get measurement point ID>> |
localTimeAccuracy | Optional | Boolean |
|
localTimeFormat | Optional | Integer | Specify whether the local time value includes time zone information of devices. 0 (default): without time zone information; 1: with time zone information. |
itemFormat | Optional | Integer | Specify the displaying format of the returned device data. Available options are 0, 1, and 2. For the example of each displaying format, see Item Format Example>> |
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¶
{
"assetId": "yourAssetId",
"timestamp": 1590076800000,
"sum(yourPointId)": 10.615000000000002,
"localtime": "2020-05-22 00:00:00"
}
Parameters¶
Name | Data Type | Description |
---|---|---|
assetId | String | The asset ID. |
timestamp | Long | The data timestamp (UNIX time, accurate to the second). |
sum(pointId) | Double | This parameter is a variable, representing the identifier and data of the measurement point. The data here is the daily aggregation of the sum of power sonsumption/production data. |
localtime | String | Local time stamp of the returned data. |
Error Codes¶
For description of error codes, see Common Error Codes.
Samples¶
Request Sample¶
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
}
Return Sample¶
{
"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 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;
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. 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.
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);
}
}