2022-09-20
目录

报警

# 概述

报警

类名

AlarmApi.java

成员方法

名称 方法 Method Path
确认报警 confirmAlarm POST /api-business/alarm/confirmAlarm
删除历史报警 deleteHistoryAlarm POST /api-business/alarm/deleteHistoryAlarm
获取报警配置 getAlarmConfig POST /api-business/alarm/getAlarmConfig
获取报警配置列表 getAlarmConfigList POST /api-business/alarm/getAlarmConfigList
根据报警id查询报警确认记录 getAlarmConfirmationList POST /api-business/alarm/getAlarmConfirmationList
根据报警id查询报警确认时间和报警时间 getAlarmDataList POST /api-business/alarm/getAlarmDataList
查询历史报警信息 getHistoryAlarmData POST /api-business/alarm/getHistoryAlarmData
获取实时报警信息 getRealtimeAlarmData POST /api-business/alarm/getRealtimeAlarmData

# 确认报警

ResultObject confirmAlarm(ids, confirmScheme)

根据传入的用户以及多个报警Id 确认报警信息

# 请求参数

名称 类型 描述 备注
ids List<String> N个报警Id
confirmScheme String 确认报警方案 -

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
List<String> ids = Arrays.asList(new List<String>());
String confirmScheme = "confirmScheme_example";

try {
    ResultObject result = apiInstance.confirmAlarm(ids, confirmScheme);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.confirmAlarm异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/confirmAlarm
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"ids":[],
	"confirmScheme":""
}
1
2
3
4

# 删除历史报警

ResultObject deleteHistoryAlarm(ids)

根据传入的历史报警Id 删除对应的历史报警信息

# 请求参数

名称 类型 描述 备注
ids List<String> N个历史报警Id

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
List<String> ids = Arrays.asList(new List<String>());

try {
    ResultObject result = apiInstance.deleteHistoryAlarm(ids);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.deleteHistoryAlarm异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/deleteHistoryAlarm
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"ids":[]
}
1
2
3

# 获取报警配置

ResultAlarmConfig getAlarmConfig(alarmId, deviceId)

根据传入的设备Id以及报警Id 返回对应的单个报警配置信息

# 请求参数

名称 类型 描述 备注
alarmId String 报警Id
deviceId String 设备Id

# 返回参数

ResultAlarmConfig

名称 类型 描述 备注
code String 响应码 -
data AlarmConfig 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

AlarmConfig

名称 类型 描述 备注
alarmClassify String 报警分类（自定义的分类） -
alarmGroup Long 报警所属分组 一个32位二进制的值 -
alarmId Integer 报警id -
alarmName String 报警名称 -
confirmType String 报警确认类型 0:手动确认, 1:恢复后自动确认, 2:只有恢复后才能手动确认 -
createdBy String 创建人 -
detail String 报警详情 -
deviceId String 虚拟设备编号 -
expression String 报警表达式 -
level String 报警级别 0：一般，1：重要，2：紧急 -
position String 报警位置 -
pushDelayTime String 延迟推送时间(单位秒,为0时不延迟) -
pushRestoreMessage String 是否推送报警恢复消息 0：否，1：是 -
restoreMessage String 报警恢复详情 -
sort Integer 排序号 -
variantId Integer 变量id -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
String alarmId = "alarmId_example";
String deviceId = "deviceId_example";

try {
    ResultAlarmConfig result = apiInstance.getAlarmConfig(alarmId, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.getAlarmConfig异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/getAlarmConfig
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"alarmId":"",
	"deviceId":""
}
1
2
3
4

# 获取报警配置列表

ResultListAlarmConfig getAlarmConfigList(deviceId)

根据传入的设备Id 返回对应的报警配置列表

# 请求参数

名称 类型 描述 备注
deviceId String 设备Id

# 返回参数

ResultListAlarmConfig

名称 类型 描述 备注
code String 响应码 -
data List<AlarmConfig> 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

AlarmConfig

名称 类型 描述 备注
alarmClassify String 报警分类（自定义的分类） -
alarmGroup Long 报警所属分组 一个32位二进制的值 -
alarmId Integer 报警id -
alarmName String 报警名称 -
confirmType String 报警确认类型 0:手动确认, 1:恢复后自动确认, 2:只有恢复后才能手动确认 -
createdBy String 创建人 -
detail String 报警详情 -
deviceId String 虚拟设备编号 -
expression String 报警表达式 -
level String 报警级别 0：一般，1：重要，2：紧急 -
position String 报警位置 -
pushDelayTime String 延迟推送时间(单位秒,为0时不延迟) -
pushRestoreMessage String 是否推送报警恢复消息 0：否，1：是 -
restoreMessage String 报警恢复详情 -
sort Integer 排序号 -
variantId Integer 变量id -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
String deviceId = "deviceId_example";

try {
    ResultListAlarmConfig result = apiInstance.getAlarmConfigList(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.getAlarmConfigList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/getAlarmConfigList
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"deviceId":""
}
1
2
3

# 根据报警id查询报警确认记录

ResultListAlarmAffirmVo getAlarmConfirmationList(param)

根据报警id查询报警确认记录

# 请求参数

名称 类型 描述 备注
param AlarmParam param

# AlarmParam

名称 类型 描述 备注
alarmId String ID -
deviceId String 设备id -

# 返回参数

ResultListAlarmAffirmVo

名称 类型 描述 备注
code String 响应码 -
data List<AlarmAffirmVo> 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

AlarmAffirmVo

名称 类型 描述 备注
confirmScheme String 确认方案 -
confirmTime String 确认报警时间 -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
AlarmParam param = new AlarmParam();

try {
    ResultListAlarmAffirmVo result = apiInstance.getAlarmConfirmationList(param);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.getAlarmConfirmationList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/getAlarmConfirmationList
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"alarmId":"",
	"deviceId":""
}
1
2
3
4

# 根据报警id查询报警确认时间和报警时间

ResultListAlarmTimeVo getAlarmDataList(param)

根据报警id查询报警确认时间和报警时间

# 请求参数

名称 类型 描述 备注
param AlarmParam param

# AlarmParam

名称 类型 描述 备注
alarmId String ID -
deviceId String 设备id -

# 返回参数

ResultListAlarmTimeVo

名称 类型 描述 备注
code String 响应码 -
data List<AlarmTimeVo> 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

AlarmTimeVo

名称 类型 描述 备注
alarmTime String 报警时间 -
confirmTime String 确认报警时间 -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
AlarmParam param = new AlarmParam();

try {
    ResultListAlarmTimeVo result = apiInstance.getAlarmDataList(param);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.getAlarmDataList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/getAlarmDataList
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"alarmId":"",
	"deviceId":""
}
1
2
3
4

# 查询历史报警信息

ResultIPageHistoryAlarmVo getHistoryAlarmData(alarmQueryParam)

根据param 查询出对应的历史报警信息

# 请求参数

名称 类型 描述 备注
alarmQueryParam AlarmQueryParam alarmQueryParam

# AlarmQueryParam

名称 类型 描述 备注
alarmLevel String 报警级别0：一般，1：重要，2：紧急 -
currentPage Integer 分页页码 -
deviceId String 设备ID -
endTime String 结束时间 yyyy-MM-dd hh:mm:ss -
keyword String 条件搜索 -
pageSize Integer 每页大小 -
projectId String 项目ID -
startTime String 开始时间 yyyy-MM-dd hh:mm:ss -

# 返回参数

ResultIPageHistoryAlarmVo

名称 类型 描述 备注
code String 响应码 -
data IPageHistoryAlarmVo 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

IPageHistoryAlarmVo

名称 类型 描述 备注
current Long -
hitCount Boolean -
pages Long -
records List<HistoryAlarmVo> -
searchCount Boolean -
size Long -
total Long -

HistoryAlarmVo

名称 类型 描述 备注
alarmDetail String 报警详情 -
alarmId String 报警配置id -
alarmLevel String 报警详情0：一般，1：重要，2：紧急 -
alarmRemark String 报警备注 -
alarmTime OffsetDateTime 报警时间 -
confirmScheme String 确认方案 -
confirmTime OffsetDateTime 确认报警时间 -
confirmType String 确认类型 -
deviceId String 虚拟设置id -
deviceName String 采集器名称 -
id String 报警id -
projectName String 项目名称 -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
AlarmQueryParam alarmQueryParam = new AlarmQueryParam();

try {
    ResultIPageHistoryAlarmVo result = apiInstance.getHistoryAlarmData(alarmQueryParam);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.getHistoryAlarmData异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/getHistoryAlarmData
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"pageSize":0,
	"alarmLevel":"",
	"startTime":"",
	"endTime":"",
	"currentPage":0,
	"keyword":"",
	"deviceId":"",
	"projectId":""
}
1
2
3
4
5
6
7
8
9
10

# 获取实时报警信息

ResultIPageRealTimeAlarmVo getRealtimeAlarmData(alarmQueryParam)

通过Form参数 分页查询实时报警

# 请求参数

名称 类型 描述 备注
alarmQueryParam AlarmQueryParam alarmQueryParam

# AlarmQueryParam

名称 类型 描述 备注
alarmLevel String 报警级别0：一般，1：重要，2：紧急 -
currentPage Integer 分页页码 -
deviceId String 设备ID -
endTime String 结束时间 yyyy-MM-dd hh:mm:ss -
keyword String 条件搜索 -
pageSize Integer 每页大小 -
projectId String 项目ID -
startTime String 开始时间 yyyy-MM-dd hh:mm:ss -

# 返回参数

ResultIPageRealTimeAlarmVo

名称 类型 描述 备注
code String 响应码 -
data IPageRealTimeAlarmVo 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

IPageRealTimeAlarmVo

名称 类型 描述 备注
current Long -
hitCount Boolean -
pages Long -
records List<RealTimeAlarmVo> -
searchCount Boolean -
size Long -
total Long -

RealTimeAlarmVo

名称 类型 描述 备注
alarmDetail String 报警详情 -
alarmId String 报警配置id -
alarmLevel String 报警详情0：一般，1：重要，2：紧急 -
alarmRemark String 报警备注 -
alarmTime OffsetDateTime 报警时间 -
confirmType String 确认类型 0: 手动确认, 1: 恢复后自动确认, 2: 恢复后手动确认 -
deviceId String 虚拟设置id -
deviceName String 采集器名称 -
id String 报警id -
projectName String 项目名称 -
restore String 恢复确认类型 0: 未恢复, 1: 已恢复 -

# java-sdk 调用示例

//实例化api类，传入token
AlarmApi apiInstance = new AlarmApi(token);
//实例化请求参数
AlarmQueryParam alarmQueryParam = new AlarmQueryParam();

try {
    ResultIPageRealTimeAlarmVo result = apiInstance.getRealtimeAlarmData(alarmQueryParam);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用AlarmApi.getRealtimeAlarmData异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-business/alarm/getRealtimeAlarmData
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"pageSize":0,
	"alarmLevel":"",
	"startTime":"",
	"endTime":"",
	"currentPage":0,
	"keyword":"",
	"deviceId":"",
	"projectId":""
}
1
2
3
4
5
6
7
8
9
10
系统
标签

← 标签→

最近更新
01
OPC UA
 02-02
02
环保协议（HJ212）
 02-02
03
MQTT
 02-02
更多文章>
Copyright © 2021-2024