Batch Create Active Alerts¶
Batch create active alerts.
Note
As long as one alert fails the format verification, all alerts cannot be created.
Request Format¶
POST https://{apigw-address}/event-service/v2.1/active-alerts?action=batchCreate
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 orgId>> |
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
activeAlert |
Mandatory |
Array of ActiveAlert Structs |
The list of active alerts. For details of an activeAlert struct, see ActiveAlert Struct>> |
ActiveAlert Struct
Note
You must specify either measurepointId or deviceStatus as the trigger of the alert.
Name |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
assetId |
Mandatory |
String |
The asset ID. How to get assetId>> |
modelId |
Mandatory |
String |
The model ID. How to get modelID>> |
modelIdPath |
Optional |
String |
The model ID path. |
measurepointId |
Optional |
String |
The measurement point ID. You must specify either |
deviceStatus |
Optional |
String |
The device status, such as “offline”. You must specify either |
value |
Mandatory |
Object |
The measurement point value. |
occurTime |
Mandatory |
Long |
The UTC time when the alert occurs. For time formats, see ISO8601 Standard Time Formats Used by UTC>> |
localOccurTime |
Optional |
String |
The local time when the alert occurs. For time formats, see Data and Time Formats Used by Localtime>> |
severityId |
Optional |
String |
The alert severity ID. |
severityDesc |
Optional |
StringI18n |
Specify the alert severity’s description in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct |
typeId |
Optional |
String |
The alert type ID. |
typeDesc |
Optional |
StringI18n |
Specify the alert type’s description in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct |
subTypeId |
Optional |
String |
The alert sub-type ID. |
subTypeDesc |
Optional |
StringI18n |
Specify the alert sub-type’s description in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct |
contentId |
Optional |
String |
The alert content ID. |
contentDesc |
Optional |
StringI18n |
Specify the alert content’s description in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct |
tags |
Optional |
Map |
The user-defined tags. (The Key and Value are of String type.) For details, see How to use tags |
Response Parameters¶
Name |
Data Type |
Description |
|---|---|---|
data |
Array of EnosBatchEachData Struct |
The list of success or failure messages. For the details of an enosBatchEachData struct, see the table below. |
successSize |
Integer |
The number of sucessfully created active alerts. |
totalSize |
Integer |
The total number of active alerts to be created. |
EnosBatchEachData Struct¶
Name |
Data Type |
Description |
|---|---|---|
code |
Integer |
Failed or succeeded to create an alert. 0: succeeded, -1: failed |
msg |
String |
The message indicating whether the format is correct or wrong. |
data |
String |
If successful, it will return the |
Samples¶
Request Sample¶
url: https://{apigw-address}/event-service/v2.1/active-alerts?action=batchCreate&orgId=yourOrgId
method: POST
requestBody:
{
"activeAlertList": [{
"assetId": "asset",
"contentDesc": {
"defaultValue": "default2",
"i18nValue": {
"en_US": "english",
"zh_CN": "中文"
}
},
"contentId": "content",
"localOccurTime": "2019-11-07 15:15:58",
"measurepointId": "point111",
"modelId": "model",
"modelIdPath": "/path-path-path",
"occurTime": 1573110958644,
"orgId": "yourOrgId",
"severityDesc": {
"defaultValue": "default",
"i18nValue": {
"en_US": "english",
"zh_CN": "中文"
}
},
"severityId": "severity",
"tag": {
"key1": "v1 "
},
"typeDesc": {
"defaultValue": "default1",
"i18nValue": {
"en_US": "english",
"zh_CN": "中文"
}
},
"typeId": "type",
"value": 1
}],
"action": "batchCreate"
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"requestId": "08f7c947-8c4e-4512-9764-58258173186e",
"data": [{
"code": 0,
"msg": "format right",
"data": "201911072a7658def1801fa23dc0ba494e2f38c8"
}],
"successSize": 1,
"totalSize": 1
}
Java SDK Sample¶
package com.envisioniot.enos.event_service;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.api.common.constant.request.Pagination;
import com.envisioniot.enos.event_service.v2_1.*;
import com.envisioniot.enos.event_service.vo.*;
import com.google.common.collect.Lists;
import com.google.gson.Gson;
import org.junit.Test;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
private GenerateActiveAlert buildActiveAlert() {
GenerateActiveAlert activeAlert = new GenerateActiveAlert();
activeAlert.setAssetId("asset");
activeAlert.setModelId("model");
activeAlert.setModelIdPath("/path-path-path");
activeAlert.setMeasurepointId("point111");
activeAlert.setValue(1);
long now = System.currentTimeMillis();
activeAlert.setOccurTime(now);
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String localTime = df.format(now);
activeAlert.setLocalOccurTime(localTime);
activeAlert.setSeverityId("severity");
StringI18n desc = new StringI18n();
desc.setDefaultValue("default");
Map < String, String > map = new HashMap < > ();
map.put("zh_CN", "中文");
map.put("en_US", "english");
desc.setI18nValue(map);
activeAlert.setSeverityDesc(desc);
activeAlert.setTypeId("type");
StringI18n desc1 = new StringI18n();
desc1.setDefaultValue("default1");
Map < String, String > map1 = new HashMap < > ();
map1.put("zh_CN", "中文");
map1.put("en_US", "english");
desc1.setI18nValue(map1);
activeAlert.setTypeDesc(desc1);
activeAlert.setContentId("content");
StringI18n desc2 = new StringI18n();
desc2.setDefaultValue("default2");
Map < String, String > map2 = new HashMap < > ();
map2.put("zh_CN", "中文");
map2.put("en_US", "english");
desc2.setI18nValue(map2);
activeAlert.setContentDesc(desc2);
return activeAlert;
}
public void testBatchCreateActiveAlert() {
String accessKey = "yourAppAccessKey";
String secretKey = "yourAppSecretKey";
String orgId = "yourOrgId";
String url = "https://{apigw-address}";
BatchCreateActiveAlertsRequest request = new BatchCreateActiveAlertsRequest();
request.setOrgId(orgId);
List < GenerateActiveAlert > list = Lists.newArrayList();
GenerateActiveAlert activeAlert1 = buildActiveAlert();
Map < String, String > tags = new HashMap < > ();
tags.put("yourTagKey1", "yourTagValue1");
activeAlert1.setTag(tags);
list.add(activeAlert1);
GenerateActiveAlert activeAlert2 = buildActiveAlert();
tags = new HashMap < > ();
tags.put("yourTagKey2", "yourTagValue2");
activeAlert2.setTag(tags);
list.add(activeAlert2);
GenerateActiveAlert activeAlert3 = buildActiveAlert();
tags = new HashMap < > ();
tags.put("yourTagKey3", "yourTagValue3");
activeAlert3.setTag(tags);
list.add(activeAlert3);
request.setActiveAlertList(list);
try {
BatchCreateActiveAlertsResponse response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url(url)
.getResponse(request, BatchCreateActiveAlertsResponse.class);
System.out.println(response);
} catch (Exception e) {
System.out.print(e);
}
}