Search Active Alerts¶

Query the active alerts.

Request Format¶

POST https://{apigw-address}/event-service/v2.1/active-alerts?action=search

Request Parameters (URI)¶

Name	Location (Path/Query)	Required or Not	Data Type	Description
orgId	Query	true	String	Organization ID which the asset belongs to. How to get orgId>>

Request Parameters (Body)¶

Name	Required or Not	Data Type	Description
modelId	false	String	Model ID which the asset belongs to. How to get modelID>>
assetId	false	String	Asset ID. How to get assetId>>
measurepointsId	false	String	Measurement point ID. How to get pointId>>
startOccurTime	false	String	Start time for triggering alert. See Time parameters used in API>>
endOccurTime	false	String	End time for triggering alert. See Time parameters used in API>>
expression	false	String	Query expression, which supports for sql-like query. The fields that are supported for query include: `modelId`, `assetId`, `measurepointId`, `hitRuleId`, `severityId`, `typeId`, `subTypeId`, `contentId`, `eventType`, `eventId`, `tag`, and `assetPath`. The supported arithmetic operators are “=” and “in”, and the logical operator is “and” and “or”. `tag` also supports arithmetic operator “exists” and “not exists”. How to use expression>>
scope	false	Scope struct	Query the alerts in a specified asset tree or in an asset node on the asset tree, and specify whether to return the blocked derivative alerts. This parameter cannot be applied with rootAlert. See Scope Struct.
rootAlert	false	RootAlert struct	Query the derivative alerts which are blocked by the specified root alert. This parameter cannot be applied with scope.See RootAlert Struct.
pagination	false	Pagination request struct	Random pagination. The default is to sort in descending order by `occurTime`. When not specified, the default pagination size is 10 pages. See Pagination Request Struct>>

Scope Struct ¶

Name	Required or Not	Data Type	Description
treeId	true	String	ID of the asset tree
fromAssetId	false	String	Asset ID. Optional. When it is not specified, return the alerts of all nodes in the asset tree specified by `treeId`; When it is specified, returns all alerts under the asset node (and in the node).
includeDerivative	false	Boolean	Whether to return the derivative alerts, the default is false, as no derivative alert is returned.

RootAlert Struct ¶

Name	Required or Not	Data Type	Description
treeId	false	String	ID of the asset tree
rootAlertId	true	String	Root alert ID

Response Parameters¶

Name	Data Type	Description
data	ActiveAlert struct	List of active alerts. For details, see ActiveAlert Struct.

ActiveAlert Struct ¶

Name	Data Type	Description
eventId	String	Alert ID
orgId	String	Organization ID which the asset belongs to.
assetId	String	Asset ID.
modelId	String	Model ID which the asset belongs to.
modelIdPath	String	Model path
measurepointId	String	Asset measurement point
hitRuleId	String	Rule ID of the triggered alert
value	Integer/Double/Object	Measurement point value. If `triggeringDelayTimer` is specified in the alert rule, this value is that when `triggeringDelayTimer` starts counting. See ThingModel Struct>>definition
occurTime	Long	UTC time when the alert occurs
localOccurTime	String	Local time when the alert occurs
createTime	Long	UTC time for creation
updateTime	Long	UTC time for update
severityId	String	Alert severity ID
severityDesc	StringI18n	Alert severity description
typeId	String	Alert type ID
typeDesc	StringI18n	Alert type description
subTypeId	String	Alert sub-type
subTypeDesc	StringI18n	Alert sub-type description
contentId	String	Alert content ID
contentDesc	StringI18n	Alert description
eventType	Integer	Event type: 0 - system recovery alert; 1 - system-triggered alert; 2 - alert recovered by API; 3 - alarm inserted by API
tag	Tag struct	Alert tags
ruleDesc	StringI18n	Rule description
assetPaths	String Array	A path list of the alert assets on the asset tree according to the scope of the alert rule. The format is as: [“treeId1:/assetId1/assetId2/assetIdx”, “treeId2:/assetId3/assetIdx”]
maskedBy	String Array	If an alert is a derivative alert, return the root alert that caused the alert to be blocked. The format is as: [“treeId1:eventId1”, “treeId1:eventId2”]

Input/Output Samples¶

Request Sample¶

POST https://{apigw-address}/event-service/v2.1/active-alerts?action=search &orgId=1c499110e8800000
{
    "expression": "eventId='20190531b83331a8549e1e956f2413552eda1ec9'",
    "pagination": {
        "pageNo": 1,
        "pageSize": 20
                  }
}

Return Sample¶

{
    "pagination": {
        "pageNo": 1,
        "pageSize": 20,
        "totalSize": 1,
        "sortedBy": [{
            "field": "occurTime",
            "order": "DESC"
                     },
            {
            "field": "eventId",
            "order": "DESC"
            }]
                  },
    "code": 0,
    "msg": "OK",
    "requestId": "a9689b9f-0cb6-4e47-a41c-bd459b687309",
    "data": [{
        "eventId": "20190531b83331a8549e1e956f2413552eda1ec9",
        "orgId": "yourOrgId",
        "assetId": "qu5TmJRj",
        "modelId": "Inverter_Model",
        "modelIdPath": "/Inverter_Model",
        "measurepointId": "power",
        "value": "3.5559796405967736",
        "occurTime": 1559304899404,
        "localOccurTime": "2019-06-01 02:14:59",
        "createTime": 1559304899519,
        "updateTime": 1560745022684,
        "severityId": "alert_001",
        "severityDesc": {
            "i18nValue": {
                "en_US": "alert",
                "zh_CN": "alert"
                         }
                        },
        "typeId": "errorType",
        "typeDesc": {
            "i18nValue": {
                "en_US": "errorType desc",
                "zh_CN": ""
                         }
                    },
        "contentId": "001",
        "contentDesc": {
            "i18nValue": {
                "en_US": "001",
                "zh_CN": "001"
                         }
                       },
        "eventType": 1,
        "tag": {
            "Tag999": "999"
               }
            }]
}

Java SDK Sample¶

public void testSearchActiveAlerts(){
        String accessKey = "4ced4f38-1ced-476e0a446215-a602-4307";
        String secretKey = "0a446215-a602-4307-9ff2-3feed3e983ce";
        SearchActiveAlertRequest request = new SearchActiveAlertRequest();
        request.setOrgId("1c499110e8800000");
        request.setExpression("eventId='20190531b83331a8549e1e956f2413552eda1ec9'");
        Pagination pagination = new Pagination();
        pagination.setPageSize(20);
        pagination.setPageNo(1);
            request.setPagination(pagination);
            request.headerParams().put("apim-accesskey","4ced4f38-1ced-476e0a446215-a602-4307");
            try {
                SearchActiveAlertResponse response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                        .url("https://{apigw-address}")
                        .getResponse(request, SearchActiveAlertResponse.class);
                Gson gson = new Gson();
                System.out.println(gson.toJson(response));
            }catch(Exception e){
                System.out.print(e);
            }
}