Query Alert History on Pages

Last Updated on : 2023-06-21 07:13:09download

Query the alert history on pages.

API address

GET: /v1.0/si/iot-03/alarm-record/page

Request parameter

Parameter name	Type	IN	Required	Description
monitor_object_id	String	query	false	The code of a specified monitored object.
monitor_type	String	query	false	The type of a specified metric. `energy_collect`: industrial energy consumption metric. `environment`: industrial environment metric. `vibration`: industrial vibration metric.
alarm_level	Integer	query	false	The level of a specified alert. `1`: low-level. `2`: high-level.
process_status	Integer	query	false	The processing status.
page_no	Integer	query	false	The page number.
page_size	Integer	query	false	The number of items returned on each page. Maximum value: `100`.

Return parameter

Parameter name	Type	Description
result	Page	The returned result.

Description of result

Parameter name	Type	Description
total	Long	The total number of items.
list	List	The returned list.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
process_remark	String	The remarks.
range_value	String	The interval value.
alarm_level	Integer	The level of a specified alert. `1`: low-level. `2`: high-level.
monitor_object_name	String	The name of a specified monitored object.
process_time	Long	The processing time.
id	Long	The ID of the primary key.
alarm_value	Double	The alert value.
alarm_config_id	Long	The ID of a specified alert configuration.
process_status	Integer	The processing status. `0`: to be processed. `1`: already processed.
tuya_device_id	String	The device ID.
monitor_object_id	String	The ID of a specified monitored object.
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`: (-∞…+∞)
monitor_type_name	String	The type name of a specified metric.
process_person	String	The name of the processor.
alarm_time	Long	The time when an alert is triggered.
monitor_type	String	The type of a specified metric. `energy_collect`: industrial energy consumption metric. `environment`: industrial environment metric. `vibration`: industrial vibration metric.
monitor_object_type	String	The type of a specified monitored object. `energy_collect`: industrial energy consumption. `environment`: industrial environment. `vibration`: industrial vibration.
attr_code	String	The code of a specified attribute.
attr_name	String	The name of a specified attribute.
gmt_modified	Long	The time when it is updated.

Request example

GET: /v1.0/si/iot-03/alarm-record/page

Return example

{
  "result": {
    "has_more": false,
    "list": [
      {
        "alarm_config_id": 146334359530244****,
        "alarm_level": 2,
        "alarm_time": 1637757323784,
        "alarm_value": 66,
        "attr_code": "co2_value",
        "attr_name": "CO2 detection value",
        "gmt_modified": 1638241150321,
        "id": 146348640464735****,
        "monitor_object_id": "146334101962229****",
        "monitor_object_type": "",
        "monitor_type": "environment",
        "monitor_type_name": "Industrial environment"
        "process_person": "hh",
        "process_remark": "111111",
        "process_status": 1,
        "process_time": 1638241150291,
        "range_rule": "greaterThan",
        "range_value": "50",
        "tuya_device_id": "vdevo16376349197****"
      }
    ],
    "total": 1
  },
  "success": true,
  "t": 1638270806094
}

Error code

For more information, see error code.

Prev DocEnvironmental alarm management

Next DocProcess Alert History