Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart IndustryIndustrial Environment AnalyticsEnvironmental alarm configurationGet Alert Config List

Get Alert Config List

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

Get a list of alert configurations of a specified monitored object on pages.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
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.
monitor_object_id	String	query	false	The code of a specified monitored object.
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
alarm_rules	List	The collection of alert rules.
monitor_object_id	String	The ID of a specified monitored object.
monitor_object_name	String	The name of a specified alert object.
id	Long	The ID of the primary key.
monitor_type_name	String	The type name of a specified metric.
monitor_type	String	The type of a specified metric. `energy_collect`: industrial energy consumption metric. `environment`: industrial environment metric. `vibration`: industrial vibration metric.
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/page

{
  "monitor_type": "environment",
  "monitor_object_id": "11",
  "alarm_rules": [
    {
      "attr_code": "co21",
      "rang_rule": "greaterThan",
      "rang_value": "101",
      "alarm_level": 2
    },
    {
      "attr_code": "o21",
      "rang_rule": "greaterThan",
      "rang_value": "111",
      "alarm_level": 21
    }
  ]
}

Return example

{
    "result": {
        "list": [
            {
                "monitor_type_name": "Industrial environment",
                "gmt_modified": 1638238787812,
                "monitor_object_id": "11",
                "id": "146550581080852****",
                "monitor_type": "environment"
            }
        ],
        "total": 1,
        "has_more": false
    },
    "t": 1638238794169,
    "success": true
}

Error code

For more information, see error code.

Prev DocEnvironmental alarm configuration

Next DocGet Alert Config Details