Get Asset DI Data Duration¶
获取指定设备的指定测点在一段时间内不同状态（DI）的时长统计。
操作权限¶
需授权的资源 |
所需操作权限 |
|---|---|
资产 |
Read |
有关各资源及其对应的权限，参考 策略，角色，与权限>>
使用GET方法¶
请求格式¶
GET https://{apigw-address}/tsdb-service/v2.0/di/duration
请求参数（URI）¶
名称 |
位置（Path/Query） |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
modelId |
Query |
可选 |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
Query |
必需 |
String |
资产ID，支持查询多个资产，多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
measurepoints |
Query |
必需 |
String |
资产测点，支持多测点查询，各个测点间用逗号隔开。如何获取pointId信息>> |
startTime |
Query |
必需 |
String |
采样数据开始时间，支持local时间和UTC时间。local时间的格式为 |
endTime |
Query |
必需 |
String |
采样数据结束时间，格式必须与开始时间保持一致。 |
status |
Query |
可选 |
String |
对包含多个状态时长统计的结果进行筛选，例如只需要状态0结果，可输入 0 。支持对多个状态进行筛选，多个状态之间用英文逗号隔开。 |
ifWithUnknown |
Query |
可选 |
Boolean |
某段时间内的状态无法确认，默认返回为“Unknown”状态，参数标识是否包含此状态。默认为true，即包含。 |
响应参数
名称 |
数据类型 |
描述 |
|---|---|---|
data |
List<JSONObject> |
资产数据列表。单设备单点的返回数据按时间升序排列。详见 items |
items¶
示例¶
{
"scanEndTimestamp": 1569859800000,
"measurepoint": "yourPointId",
"assetId": "yourAssetId",
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
}
]
}
参数¶
名称 |
数据类型 |
描述 |
|---|---|---|
scanEndTimestamp |
Long |
此参数标志时长统计所需要扫描的最后一条数据对应时间戳。一次时长统计扫描的数据不得超过640000条，当在用户期望的起止时间内扫描到的数据超过640000条时，停止扫描，此参数返回扫描到的最后一个点的时间戳，表示此时间戳后的数据未进行统计。 |
assetId |
String |
资产ID |
measurepoint |
String |
测点标识符。 |
durations |
List<JSONObject> |
各个状态的时长统计。 |
status |
Integer |
对应设备测点的值。 |
duration |
Integer |
上述设备测点的值在用户选择的开始时间到 |
错误码¶
有关错误码的描述，参见 通用错误码。
示例 1¶
请求示例¶
ifWithUnknown为true：
url: https://{apigw-address}/tsdb-service/v2.0/di/duration?orgId=yourOrgId&assetIds=yourAssetIds&measurepoints=yourPointIds&startTime=2019-06-01%2000:00:00&endTime=2019-06-11%2023:00:00&ifWithUnknown=true
method: GET
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"scanEndTimestamp": 1569859380000,
"measurepoint": "yourPointId",
"assetId": "yourAssetId",
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
},
{
"duration": 180000,
"status": "Unknown"
}
]
},
{
"scanEndTimestamp": 1569859380000,
"measurepoint": "yourPointId",
"assetId": "yourAssetId",
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
},
{
"duration": 180000,
"status": "Unknown"
}
]
}
]
}
}
示例 2¶
请求示例¶
ifWithUnknown为false：
url: https://{apigw-address}/tsdb-service/v2.0/di/duration?orgId=yourOrgId&assetIds=yourAssetIds&measurepoints=yourPointIds&startTime=2019-06-01%2000:00:00&endTime=2019-06-11%2023:00:00&ifWithUnknown=false
method: GET
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
},
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
}
]
}
}
示例 3¶
请求示例¶
进行status筛选：
备注
进行``status``筛选后，返回结果不会有Unknown的状态。
url: https://{apigw-address}/tsdb-service/v2.0/di/duration?orgId=yourOrgId&assetIds=yourAssetIds&measurepoints=yourPointIds&startTime=2019-06-01%2000:00:00&endTime=2019-06-11%2023:00:00&status=1
method: GET
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
},
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
}
]
}
}
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 void GetAssetStatusDataTest(){
//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("modelId", "yourModelId");
request.setQueryParam("assetIds","yourAssetIds");
request.setQueryParam("measurepoints", "yourPointIds");
request.setQueryParam("startTime", "2019-06-01 00:00:00"); //或UTC时间：2019-06-01T00:00:00+08:00
request.setQueryParam("endTime", "2019-06-11 23:00:00"); //或UTC时间：2019-06-11T23:00:00+08:00
request.setQueryParam("ifWithUnknown", false);
request.setQueryParam("status", "1,2");
request.setMethod("GET");
try {
JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url("https://{apigw-address}/tsdb-service/v2.0/di/duration")
.getResponse(request, JSONObject.class);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}
}
使用POST方法¶
请求格式¶
POST https://{apigw-address}/tsdb-service/v2.0/di/duration
请求参数（Body）¶
名称 |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|
orgId |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
modelId |
可选 |
String |
资产所属模型ID。如何获取modelId信息>> |
assetIds |
必需 |
String |
资产ID，支持查询多个资产，多个资产ID之间用英文逗号隔开。如何获取Asset ID信息>> |
measurepoints |
必需 |
String |
资产测点，支持多测点查询，各个测点间用逗号隔开。如何获取pointId信息>> |
startTime |
必需 |
String |
采样数据开始时间，支持local时间和UTC时间。local时间的格式为 |
endTime |
必需 |
String |
采样数据结束时间，格式必须与开始时间保持一致。 |
status |
可选 |
String |
对包含多个状态时长统计的结果进行筛选，例如只需要状态0结果，可输入 0 。支持对多个状态进行筛选，多个状态之间用英文逗号隔开。 |
ifWithUnknown |
可选 |
String |
某段时间内的状态无法确认，默认返回为“Unknown”状态，参数标识是否包含此状态。默认为true，即包含。 |
响应参数¶
参见 使用GET方法 中的描述。
错误码¶
有关错误码的描述，参见 通用错误码。
示例 1¶
请求示例¶
ifWithUnknown为true：
url: https://{apigw-address}/tsdb-service/v2.0/di/duration
method: POST
Content-Type: multipart/form-data;charset=UTF-8
requestBody:
{
"orgId": "yourOrgId",
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-03-01 00:00:00",
"endTime": "2020-03-02 00:00:00",
"ifWithUnknown": true
}
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"scanEndTimestamp": 1569859380000,
"measurepoint": "yourPointId",
"assetId": "yourAssetId",
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
},
{
"duration": 180000,
"status": "Unknown"
}
]
},
{
"scanEndTimestamp": 1569859380000,
"measurepoint": "yourPointId",
"assetId": "yourAssetId",
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
},
{
"duration": 180000,
"status": "Unknown"
}
]
}
]
}
}
示例 2¶
请求示例¶
ifWithUnknown为false：
url: https://{apigw-address}/tsdb-service/v2.0/di/duration
method: POST
Content-Type: multipart/form-data;charset=UTF-8
requestBody:
{
"orgId": "yourOrgId",
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-03-01 00:00:00",
"endTime": "2020-03-02 00:00:00",
"ifWithUnknown": false
}
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
},
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
},
{
"duration": 60000,
"status": 2
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
}
]
}
}
示例 3¶
请求示例¶
进行status筛选：
备注
进行`status`筛选后，返回结果不会有Unknown的状态。
url: https://{apigw-address}/tsdb-service/v2.0/di/duration
method: POST
Content-Type: multipart/form-data;charset=UTF-8
requestBody:
{
"orgId": "yourOrgId",
"assetIds": "yourAssetIds",
"pointIds": "yourPointIds",
"startTime": "2020-03-01 00:00:00",
"endTime": "2020-03-02 00:00:00",
"status": "1"
}
返回示例¶
{
"status": 0,
"requestId": null,
"msg": "success",
"submsg": null,
"data": {
"items": [
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
},
{
"scanEndTimestamp": 1569859380000,
"durations": [
{
"duration": 60000,
"status": 1
}
],
"measurepoint": "yourPointId",
"assetId": "yourAssetId"
}
]
}
}
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("modelId", "yourModelId");
request.setFormParam("assetIds","yourAssetIds");
request.setFormParam("measurepoints", "yourPointIds");
request.setFormParam("startTime", "2019-06-01 00:00:00"); //或UTC时间：2019-06-01T00:00:00+08:00
request.setFormParam("endTime", "2019-06-11 23:00:00"); //或UTC时间：2019-06-11T23:00:00+08:00
request.setFormParam("ifWithUnknown", false);
request.setFormParam("status", "1,2");
request.setMethod("POST");
try {
JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url("https://{apigw-address}/tsdb-service/v2.0/di/duration")
.getResponse(request, JSONObject.class);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}
}