Get Alert Config Details

Last Updated on : 2023-06-15 06:02:19

Get the alert configuration details of a specified monitored object.

API address

GET: /v1.0/iot-03/si/alarm-config/{id}

Request parameter

Parameter name	Type	IN	Required	Description
id	Long	uri	true	The ID of a specified alert configuration.

Return parameter

Parameter name	Type	Description
result	AlarmConfigDTO	The returned result.

Description of result

Parameter name	Type	Description
monitor_type	String	The type of a specified metric. `energy_collect`: industrial energy consumption metric. `environment`: industrial environment metric. `vibration`: industrial vibration metric.
monitor_type_name	String	The type name of a specified metric.
monitor_object_id	String	The ID of a specified monitored object.
monitor_object_name	String	The name of a specified alert object.
alarm_rules	List	The collection of alert rules.
id	Long	The ID of the primary key.
gmt_modified	Long	The time when it is updated.

Description of alarm_rules

Parameter name	Type	Description
attr_code	String	The code of a specified attribute.
range_rule	String	The interval rules. `open`: (a…b) `closed`: [a…b] `closedOpen`: [a…b) `openClosed`: (a…b] `greaterThan`: (a…+∞) `atLeast`: [a…+∞) `lessThan`: (-∞…b) `atMost`: (-∞…b] `all`: (-∞…+∞)
range_value	String	The interval value.
alarm_config_id	Long	The ID of a specified alert configuration.
alarm_level	Integer	The level of a specified alert. `1`: low-level. `2`: high-level.
config_level	Integer	The level of configurations. `1`: low-level. `2`: high-level.
id	Long	The ID of the primary key.
gmt_modified	Long	The time when it is updated.

Request example

GET: /v1.0/iot-03/si/alarm-config/146550581080852****

Return example

{
    "result": {
        "monitor_type_name": "Industrial environment",
        "gmt_modified": 1638238801428,
        "monitor_object_id": "11",
        "alarm_rules": [
            {
                "attr_code": "co21",
                "range_value": "101",
                "alarm_config_id": "146550581080852****",
                "alarm_level": 2,
                "gmt_modified": 1638238801636,
                "config_level": 1,
                "range_rule": "greaterThan",
                "id": "146550586910515****"
            },
            {
                "attr_code": "o21",
                "range_value": "111",
                "alarm_config_id": "146550581080852****",
                "alarm_level": 21,
                "gmt_modified": 1638238801711,
                "config_level": 1,
                "range_rule": "greaterThan",
                "id": "146550586942811****"
            }
        ],
        "id": "14655058108085****",
        "monitor_type": "environment"
    },
    "t": 1638239040519,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Alert Config List

Next DocDelete Alert Config