文档中心

快速入门

一分钟了解 XMagital 平台

开始制作您的第一个应用

应用的联调与自测

成为进阶开发者

解决方案

应用认证发布

标准规范

接口文档

应用开发示例

应用开发脚手架

报警服务接口

版本记录

版本号	日期	修改内容
v0.12.2	2024-08-30	修复已知问题

报警服务

1.1 报警发生

向报警库发送自定义报警信息。

1.1.1 请求方法

POST /v1/alarm/fireAlarm

1.1.2 请求参数

序号	名称	类型	是否必填	描述
1	conditionNode	string	是	报警点唯一标识
2	sourceNode	string	否	报警源标识
3	unitId	int	否	报警点所属单元号
4	category	int	是	报警类别
5	severity	int	是	报警级别
6	type	int	否	报警类型
7	message	string	是	报警描述
8	position	string	否	报警发生的位置
9	activeState	boolean	是	激活状态
10	time	long	否	报警发生的时间，如果不填则取当前系统时间，<br />使用Unix时间戳，精确到毫秒
11	rtnTime	long	否	恢复时间，如果不填则取当前系统时间，<br />unix时间戳，精确到毫秒
12	ackedState	boolean	否	确认状态
13	ackTime	long	否	确认时间
14	ackOpsName	string	否	报警确认操作员名称，长度为256个字符
15	ackPosition	string	否	报警确认位置
16	ackNote	string	否	报警确认注解
17	value	string	否	报警值
18	comment	string	否	报警注释
19	graph	string	否	报警推图
20	extension	string	否	报警扩展字段
20	retain	boolean	否	报警保留标志，为false时表示报警已消失，客户端不再显示

1.1.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen	成功为true，失败为false

1.1.4 异常处理

异常代码	异常描述
-1	参数错误

1.1.5 示例

请求示例：POST /v1/alarm/fireAlarm

{
	"conditionNode": "100:EQ001.AI001.LevelAlarm",
	"category": 1,
	"severity": 1,
	"message": "测点AI001产生高高限报警",
	"position": "测点1",
	"activeState": true,
	"time": 1627281919157,
	"rtnTime": 1627281919157,
	"value": "100"
}

响应示例：

"code": 0,
"message": "success",
"data": true

1.2 批量报警发生

向报警库批量发送自定义报警信息。

1.2.1 请求方法

POST /v1/alarm/fireAlarms

1.2.2 请求参数

序号	名称	类型	是否必填	描述
1	alarms	Object[]	是	报警信息数组，单个报警信息定义参考“报警发生”参数说明

1.2.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.2.4 异常处理

异常代码	异常描述
-1	参数错误

1.2.5 示例

请求示例：POST /v1/alarm/fireAlarms

{
    "alarms": [
        {
	        "conditionNode": "100:EQ001.AI001.LevelAlarm",
	        "category": 1,
	        "severity": 1,
	        "message": "测点AI001产生高高限报警",
	        "position": "测点1",
	        "activeState": true,
	        "time": 1627281919157,
	        "rtnTime": 1627281919157,
	        "value": "100"
        },
        {
	        "conditionNode": "100:EQ001.AI002.LevelAlarm",
	        "category": 2,
	        "severity": 2,
	        "message": "测点AI002产生高高限报警",
	        "position": "测点2",
	        "activeState": true,
	        "time": 1627281919157,
	        "rtnTime": 1627281919157,
	        "value": "99"
        }
    ]
}

响应示例

"code": 0,
"message": "success",
"data": [true,true]

1.3 报警确认

向报警库发送报警确认命令。

1.3.1 请求方法

POST /v1/alarm/acknowledge

1.3.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.3.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称
3	ackPosition	String	否	报警确认位置
4	ackNote	String	否	报警确认注解
5	ackTime	long	否	确认时间
6	bLog	boolen	否	产生报警时是否记录事件默认 true

1.3.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.3.4 异常处理

异常代码	异常描述
-1	参数错误、用户无操作权限

1.3.5 示例

请求示例：POST /v1/alarm/acknowledge

  {
	"conditionNodes": ["100:EQ001.AI001.LevelAlarm",
	"100:EQ001.AI002.LevelAlarm"],
	"opsName": "操作员",
	"ackPosition": "控制室1",
	"ackNote": "报警确认",
    "ackTime": 1627281919157,
    "bLog":false
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.4 报警证实

向报警库发送报警证实命令。

1.4.1 请求方法

POST /v1/alarm/confirm

1.4.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.4.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称

1.4.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.4.4 异常处理

异常代码	异常描述
-1	参数错误或用户无操作权限

1.4.5 示例

请求示例：POST /v1/alarm/confirm

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin"
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.5 报警抑制

向报警库发送报警抑制命令。

1.5.1 请求方法

POST /v1/alarm/suppress

1.5.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.5.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称
3	suppressedTime	long	否	抑制时间
4	bLog	boolen	否	产生报警时是否记录事件默认 true

1.5.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.5.4 异常处理

异常代码	异常描述
-1	参数错误或用户无操作权限

1.5.5 示例

请求示例：POST /v1/alarm/suppress

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin",
    "suppressedTime": 1627281919157,
    "bLog":false
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.6 取消抑制

向报警库发送报警取消抑制命令。

1.6.1 请求方法

POST /v1/alarm/unsuppress

1.6.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.6.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称
3	bLog	boolen	否	产生报警时是否记录事件默认 true

1.6.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.6.4 异常处理

异常代码	异常描述
-1	参数错误

1.6.5 示例

请求示例：POST /v1/alarm/unsuppress

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin",
    "bLog":false
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.7 报警禁止

向报警库发送报警禁止命令。

1.7.1 请求方法

POST /v1/alarm/disable

1.7.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.7.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称

1.7.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.7.4 异常处理

异常代码	异常描述
-1	参数错误或用户无操作权限

1.7.5 示例

请求示例：POST /v1/alarm/disable

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin"
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": [true,true]
}

1.8 取消禁止

向报警库发送报警取消禁止命令。

1.8.1 请求方法

POST /v1/alarm/enable

1.8.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.8.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称

1.8.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.8.4 异常处理

异常代码	异常描述
-1	参数错误或用户无操作权限

1.8.5 示例

请求示例：POST /v1/alarm/enable

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin"
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.9 报警搁置

向报警库发送报警搁置命令。

1.9.1 请求方法

POST /v1/alarm/shelve

1.9.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.9.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称
3	shelvedTime	long	否	搁置时间
4	bLog	boolen	否	产生报警时是否记录事件默认 true

1.9.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.9.4 异常处理

异常代码	异常描述
-1	参数错误或用户无操作权限

1.9.5 示例

请求示例：POST /v1/alarm/shelve

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin",
    "shelvedTime": 1627281919157,
    "bLog":false
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.10 取消搁置

向报警库发送报警取消搁置命令。

1.10.1 请求方法

POST /v1/alarm/unshelve

1.10.2 请求参数

参数名	示例值	参数类型	是否必填	参数描述
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQ	String	是	用户token

1.10.2.2 请求Body参数

序号	名称	类型	是否必填	描述
1	conditionNodes	String[]	是	报警点标识列表。最多支持100个报警点
2	opsName	String	否	操作员名称
3	bLog	boolen	否	产生报警时是否记录事件默认 true

1.10.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen[]	成功为true，失败为false

1.10.4 异常处理

异常代码	异常描述
-1	参数错误或用户无操作权限

1.10.5 示例

请求示例：POST /v1/alarm/unshelve

{
    "conditionNodes": [
        "100:EQ001.AI001.LevelAlarm",
        "100:EQ001.AI002.LevelAlarm"
    ],
    "opsName": "admin",
    "bLog":false
}

响应示例：

"code": 0,
"message": "success",
"data": [true,true]

1.11 报警恢复

向报警库发送报警恢复命令。

1.11.1 请求方法

POST /v1/alarm/recover

1.11.2 请求参数

序号	名称	类型	是否必填	描述
1	conditionNode	String	是	报警点标识
2	rtnTime	long	否	报警恢复的时间，如果不填则取当前系统时间使用Unix时间戳，精确到毫秒。
3	message	string	否	报警恢复描述
4	value	String	否	报警值

1.11.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen	成功为true，失败为false

1.11.4 异常处理

异常代码	异常描述
-1	参数错误

1.11.5 示例

请求示例：POST /v1/alarm/recover

"conditionNode": "100:EQ001.AI001.LevelAlarm",
"rtnTime": 1627281919157,
"message": "测点AI001高高限报警恢复",
"value": "50"

响应示例：

"code": 0,
"message": "success",
"data": true

1.12 报警个数查询

向报警库查询实时报警个数信息。

1.12.1 请求方法

POST /v1/alarm/count

1.12.2 请求参数

序号	名称	类型	是否必填	描述
1	filters	Filter	否	过滤器对象
	filters.expr	FilterExpr[]	否	条件表达式集合,每个表达式之间是and关系，该参数和filters.subFilter不能同时为空
	filters.expr.field	String	是	条件表达式字段，报警字段名称
	filters.expr.operator	String	是	表达式操作符
	filters.expr.value	Object[]	是	字段的值
	filters.op	String	否	子过滤器之间的逻辑运算符，支持and，or，默认为and
	filters.subFilter	Filter[]	否	子过滤器

1.12.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	int[]	报警对象个数

1.12.4 异常处理

异常代码	异常描述
-1	参数错误

1.12.5 示例

请求示例：POST /v1/alarm/count

示例1

示例1：过滤器条件，where ((severity = 1) or (category = 2))
{
    "filters": {
        "expr": [],//为空，可以不填
        "op": "or",//子过滤器之间的关系为or
        "subFilter": [
            {
                "expr": [
                    {
                        "field": "severity",
                        "operator": "=",
                        "value": [1]
                    }
                ],
                "op": "or",//此处子过滤器为空，不起作用，可以不填
                "subFilter": []//为空，可以不填
            },
            {
                "expr": [
                    {
                        "field": "category",
                        "operator": "=",
                        "value": [2]
                    }
                ],
                "op": "or",//此处子过滤器为空，不起作用，可以不填
                "subFilter": []//为空，可以不填
            }
        ]
    }
}

示例2

示例2：过滤器条件，where (activeState = true) and (((severity = 1 and category = 2) and (ackState = true)) or(suppressState = false))
{
    "filters": {
        "expr": [
            {
                "field": "activeState",
                "operator": "=",
                "value": [true]
            }
        ],
        "op": "or",
        "subFilter": [
            {
                "expr": [
                    {
                        "field": "severity",
                        "operator": "=",
                        "value": [1]
                    },
                    {
                        "field": "category",
                        "operator": "=",
                        "value": [2]
                    }
                ],
                "op": "or",
                "subFilter": [
                    {
                        "expr": {
                            "field": "ackState",
                            "operator": "=",
                            "value": [true]
                        }
                    }
                ]
            },
            {
                "expr": [
                    {
                        "field": "suppressState",
                        "operator": "=",
                        "value": [false]
                    }
                ],
                "op": "or",
                "subFilter": []
            }
        ]
    }
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data" :[100]
}

1.13 报警查询

向报警库查询实时报警信息。

1.13.1 请求方法

POST /v1/alarm/query

1.13.2 请求参数

序号	名称	类型	是否必填	描述
1	pageable	object	否	分页信息。不填写时，默认返回前100条
2	pageable.page	int	是	当前页，页码从1开始
3	pageable.pageSize	int	是	每页返回大小，范围1~100
4	fields	string[]	否	查询结果返回的事件字段，不填写默认返回全部字段
5	filters	Filter	否	过滤器对象
	filters.expr	FilterExpr[]	否	条件表达式集合,每个表达式之间是and关系，该参数和filters.subFilter不能同时为空
	filters.expr.field	String	是	条件表达式字段，报警字段名称
	filters.expr.operator	String	是	表达式操作符
	filters.expr.value	Object[]	是	字段的值
	filters.op	String	否	子过滤器之间的逻辑运算符，支持and，or，默认为and
	filters.subFilter	Filter[]	否	子过滤器
6	orderBy	List<field,order>	否	field报警字段名称，参考“报警标识规范”的报警对象定义。order填写desc（降序），或者asc(升序)

1.13.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	AlarmData[]	报警对象列表

1.13.4 异常处理

异常代码	异常描述
-1	参数错误

1.13.5 示例

请求示例：POST /v1/alarm/query

{
    "pageable": {
        "page": 1,
        "pageSize": 100
    },
    "fields": [
        "conditionNode",
        "severity",
        "category",
        "time"
    ],
    "filters": {
        "expr": [],
        "op": "or",
        "subFilter": [
            {
                "expr": [
                    {
                        "field": "severity",
                        "operator": "=",
                        "value": [
                            1
                        ]
                    }
                ],
                "op": "or",
                "subFilter": []
            },
            {
                "expr": [
                    {
                        "field": "category",
                        "operator": "=",
                        "value": [
                            2
                        ]
                    }
                ],
                "op": "or",
                "subFilter": []
            }
        ]
    },
    "orderBy": [
        {
            "field": "time",
            "order": "desc"
        },
        {
            "field": "severity",
            "order": "asc"
        }
    ]
}

响应示例

{
	"code": 0,
	"message": "success",
	"data" :
    	[
            {
				"conditionNode": "100:EQ001.AI001.LevelAlarm",
				"category": 1,
				"severity": 2,
				"time": 1627281919900
            }
            {
				"conditionNode": "100:EQ001.AI011.LevelAlarm",
				"category": 2,
				"severity": 2,
				"time": 1627281919900
            }
            {
				"conditionNode": "100:EQ001.AI001.LevelAlarm",
				"category": 1,
				"severity": 2,
				"time": 1627281919157
            }
        ]
}

1.14 获取报警点列表

从报警库中获取报警抑制点或者报警禁止点列表。

1.14.1 请求方法

POST /v1/alarm/getPoints

1.14.2 请求参数

序号	名称	类型	是否必填	描述
1	conditionName	string	否	1、不填写或者传空时，表示获取所有符合“报警点类型”的报警点；<br /> 2、填写如“100：”表示获取数据库单元100下符合“报警点类型”的报警点； 3、填写如“100: EQ001”表示获取数据库单元100、设备EQ001下符合“报警点类型”的报警点
2	pointType	long	是	报警点类型，可填写（1、2、3、4、5、6），具体表示如下： <br /> 1 报警抑制点 <br /> 2 报警禁止点 <br />3 设备上模拟量限值报警处于报警禁止状态的报警点 <br />4 设备上偏差报警处于报警禁止状态的报警点 <br />5 设备上变化率报警处于报警禁止状态的报警点 <br />6 设备上离散量报警处于报警禁止状态的报警点

1.14.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	string	返回信息描述
data	[]	报警点列表
data.conditionNode	string	报警点
data.time	long	Unix时间戳，精确到毫秒
data.opsName	string	操作员名称

1.14.4 异常处理

异常代码	异常描述
-1	参数错误

1.14.5 示例

请求示例：POST /v1/alarm/getPoints

{
	"conditionName":"100:",
	"pointType":3
}

响应示例

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "conditionNode": "100:EQ001.AI001.LevelAlarm",
            "time": 1627281919900,
            "opsName": "admin"
        },
        {
            "conditionNode": "100:EQ001.AI002.LevelAlarm",
            "time": 1627281919900,
            "opsName": "admin"
        },
        {
            "conditionNode": "100:EQ001.AI003.LevelAlarm",
            "time": 1627281919900,
            "opsName": "admin"
        }
    ]
}

1.15 基于模型实例的报警查询

根据设备名称向报警库查询实时报警信息。

1.15.1 请求方法

GET /v1/alarm/model?name=

1.15.2 请求参数

序号	名称	类型	是否必填	描述
1	name	String	是	模型实例名称，格式为“命名空间:模型实例名”，如“100:EQ001”

1.15.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	AlarmData[]	报警对象列表

1.15.4 异常处理

异常代码	异常描述
-1	参数错误

1.15.5 示例

请求示例：GET /v1/alarm/model?name=100:EQ001

响应示例

{
	"code": 0,
	"message": "success",
	"data" :
    	[
            {
				"conditionNode": "100:EQ001.AI001.LevelAlarm",
				"retain": true,
				"category": 1,
				"severity": 2,
				"message": "值变位报警",
				"position":"报警发生位置",
				"activeState": true,
				"time": 1627281919157,
				"rtnTime": 1627281919157,
				"ackedState": true,
				"ackedTime": 1627281919157,
				"ackNote": "报警确认信息",
				"opsName": "报警确认操作员",
				"ackPosition": "报警确认位置",
				"confirmedState": true,
				"confirmedTime": 1627281919157,
				"suppressedState": false,
				"suppressedTime": 1627281919157,
				"enabledState": true,
				"enabledTime": 1627281919157,
				"shelvedState": true,
				"shelvedTime": 1627281919157,
				"value" :"1" ,
				"comment": "报警备注信息",
    			"extension":""
			}
        ]
}

1.16 报警注释

修改报警记录注释。如果报警记录已经有注释，调用接口后将覆盖原来的注释。

1.16.1 请求方法

POST /v1/alarm/comment

1.16.2 请求参数

序号	名称	类型	是否必填	描述
1	conditionNode	string	是	报警点标识
2	comment	string	是	报警注释，允许填空字符串

1.16.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	string	返回信息描述
data	boolen	成功为true，失败为false

1.16.4 异常处理

异常代码	异常描述
-1	参数错误

1.16.5 示例

请求示例：POST /v1/alarm/comment

{
	"conditionNode": "100:EQ001.AI001.LevelAlarm",
	"comment": "测点AI001报警注释"
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": true
}

1.17 创建主题

创建报警主题。

1.17.1 请求方法

POST /v1/alarm/topic/create

1.17.2 请求参数

序号	名称	类型	是否必填	描述
1	type	short	否	主题的类型： 0 全订阅 1 数据库单元 2 报警点唯一标识 3 角色
2	contents	string[]	否	主题包含的内容

1、2参数都不填写时，表示创建一个空主题。1、2参数填写时，应用在向中间件完成订阅后，需要刷新该主题，报警服务才会推送该主题下已存在的报警。否则，只推送之后产生的报警。

1.17.3 响应参数

名称	类型	描述
code	int	返回码，0成功，1已存在，其他失败
message	String	返回信息描述
data	String	主题名称

1.17.4 异常处理

异常代码	异常描述
-1	参数错误

1.17.5 示例

请求示例：POST /v1/alarm/topic/create

{
	"type": 1,
	"contents": ["100","101","102"]
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": "almview1"
}

1.18 删除主题

删除报警主题。

1.18.1 请求方法

POST /v1/alarm/topic/delete

1.18.2 请求参数

序号	名称	类型	是否必填	描述
1	topics	string[]	是	主题

1.18.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	String	返回信息描述
data	boolen	成功为true，失败为false

1.18.4 异常处理

异常代码	异常描述
-1	参数错误

1.18.5 示例

请求示例：POST /v1/alarm/topic/delete

{
	"topics": ["almview1","almview2"]
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": true
}

1.19 查看主题

查看报警主题。

1.19.1 请求方法

GET /v1/alarm/topic?name=

1.19.2 请求参数

序号	名称	类型	是否必填	描述
1	name	string	是	主题

1.19.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	string	返回信息描述
data	object[]	主题包含的信息。1. 主题的类型（type）： 0 全订阅 1 数据库单元 2 报警点唯一标识 3 角色；2. 主题包含的内容（content）

1.19.4 异常处理

异常代码	异常描述
-1	参数错误

1.19.5 示例

请求示例：

GET  /v1/alarm/topic?name=almview1

响应示例

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "type": 1,
            "content": [
                "100",
                "101",
                "102"
            ]
        },
        {
            "type": 2,
            "content": [
                "100:EQ001.AI001.LevelAlarm",
                "100:EQ001.AI002.LevelAlarm"
            ]
        }
    ]
}

1.20 主题中增加内容

向报警主题中增加内容。

1.20.1 请求方法

POST /v1/alarm/topic/add

1.20.2 请求参数

序号	名称	类型	是否必填	描述
1	topic	string	是	报警主题
2	type	short	是	主题的类型： 0 全订阅 1 数据库单元 2 报警点唯一标识 3 角色
3	contents	string[]	否	主题包含的内容

1.20.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	string	返回信息描述
data	boolen	成功为true，失败为false

1.20.4 异常处理

异常代码	异常描述
-1	参数错误

1.20.5 示例

请求示例：POST /v1/alarm/topic/add

{
	"topic": "almview1",
	"type": 1,
	"contents": ["100","101","102"]
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": true
}

1.21 主题中删除内容

删除报警主题中的一部分内容。

1.21.1 请求方法

POST /v1/alarm/topic/remove

1.21.2 请求参数

序号	名称	类型	是否必填	描述
1	topic	string	是	报警主题
2	type	short	是	主题的类型： 0 全订阅 1 数据库单元 2 报警点唯一标识 3 角色
3	contents	string[]	否	主题包含的内容，未填写时，表示删除主题下type类型的所有内容

1.21.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	string	返回信息描述
data	boolen	成功为true，失败为false

1.21.4 异常处理

异常代码	异常描述
-1	参数错误

1.21.5 示例

请求示例：POST /v1/alarm/topic/remove

{
	"topic": "almview1",
	"type": 1,
	"contents": ["100","101"]
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": true
}

1.22 刷新主题

刷新主题，使报警服务重新推送一次主题下已存在的报警。

1.22.1 请求方法

POST /v1/alarm/topic/refresh

1.22.2 请求参数

序号	名称	类型	是否必填	描述
1	topic	string	是	报警主题

1.22.3 响应参数

名称	类型	描述
code	int	返回码，0成功，其他失败
message	string	返回信息描述
data	boolen	成功为true，失败为false

1.22.4 异常处理

异常代码	异常描述
-1	参数错误

1.22.5 示例

请求示例：POST /v1/alarm/comment

{
	"topic": "almview1"
}

响应示例：

{
	"code": 0,
	"message": "success",
	"data": true
}

报警服务接口

版本记录

报警服务

1.1 报警发生

1.1.1 请求方法

1.1.2 请求参数

1.1.3 响应参数

1.1.4 异常处理

1.1.5 示例

1.2 批量报警发生

1.2.1 请求方法

1.2.2 请求参数

1.2.3 响应参数

1.2.4 异常处理

1.2.5 示例

1.3 报警确认

1.3.1 请求方法

1.3.2 请求参数

1.3.2.1 请求Header参数

1.3.2.2 请求Body参数

1.3.3 响应参数

1.3.4 异常处理

1.3.5 示例

1.4 报警证实

1.4.1 请求方法

1.4.2 请求参数

1.4.2.1 请求Header参数

1.4.2.2 请求Body参数

1.4.3 响应参数

1.4.4 异常处理

1.4.5 示例

1.5 报警抑制

1.5.1 请求方法

1.5.2 请求参数

1.5.2.1 请求Header参数

1.5.2.2 请求Body参数

1.5.3 响应参数

1.5.4 异常处理

1.5.5 示例

1.6 取消抑制

1.6.1 请求方法

1.6.2 请求参数

1.6.2.1 请求Header参数

1.6.2.2 请求Body参数

1.6.3 响应参数

1.6.4 异常处理

1.6.5 示例

1.7 报警禁止

1.7.1 请求方法

1.7.2 请求参数

1.7.2.1 请求Header参数

1.7.2.2 请求Body参数

1.7.3 响应参数

1.7.4 异常处理

1.7.5 示例

1.8 取消禁止

1.8.1 请求方法

1.8.2 请求参数

1.8.2.1 请求Header参数

1.8.2.2 请求Body参数

1.8.3 响应参数

1.8.4 异常处理

1.8.5 示例

1.9 报警搁置

1.9.1 请求方法

1.9.2 请求参数

1.9.2.1 请求Header参数

1.9.2.2 请求Body参数

1.9.3 响应参数

1.9.4 异常处理

1.9.5 示例

1.10 取消搁置

1.10.1 请求方法

1.10.2 请求参数

1.10.2.1 请求Header参数

1.10.2.2 请求Body参数

1.10.3 响应参数

1.10.4 异常处理

1.10.5 示例

1.11 报警恢复