接口说明
详情接口
推荐每秒调用不超过15次
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-event/1.0.0/alarm-record/detail?alarmCode=&dbType=&alarmDate=
请求Method
GET
数据提交格式
application/json
请求参数
参数名称 | 必填 | 类型 | 描述 |
---|---|---|---|
alarmCode | 是 | string | 报警编号 |
dbType | 否 | string | 0代表普通查询,1代表云数据库查询,1.0.1版本新增 |
alarmDate | 是 | string | 报警记录分页查询中返回的报警时间,分表功能所加,1.0.2版本新增,形式:yyyy-MM-dd HH:mm:ss |
请求参数示例
GET 请求 alarmCode与alarmDate需要做URLencode
https://10.35.80.120/evo-apigw/evo-event/1.0.0/alarm-record/detail?alarmCode=%7B376FFB04-2DE8-A142-BDF7-DCB6494639C0%7D&dbType=0&alarmDate=2021-02-01%2001%3A03%3A00
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
success | boolean | 接口返回是否成功 |
code | string | 错误码:0-为无错误,非0-为具体错误码 |
errMsg | string | 错误消息 |
data | Object | 数据对象 |
data数据对象
参数名称 | 类型 | 描述 |
---|---|---|
id | long | 数据库id |
alarmStat | int | 报警状态 |
alarmTypeName | string | 报警事件名称 |
alarmDate | string | 报警发生时间 |
alarmPosition | string | 报警发生地点 |
handleUser | string | 处理人 |
handleDate | string | 处理时间 |
handleStat | string | 处理状态 |
handleMessage | string | 处理内容 |
alarmCode | string | 报警编号 |
orgName | string | 所属组织 |
linkNames | string | 联动能力 |
pictures | string | 联动图片地址,图片相对地址,完整地址参考OSS方式 |
taskWebName | string | 任务详情 |
alarmWebUrl | string | 参数 |
alarmAppUrl | string | 参数 |
taskWebUrl | string | 参数 |
taskAppUrl | string | 参数 |
code | string | 错误码 |
errMsg | string | 错误消息 |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 2,
"alarmStat": 1,
"alarmTypeName": "设备断线",
"alarmDate": "2019-11-22 14:23:26",
"handleUser": null,
"handleDate": "",
"handleStat": 0,
"handleMessage": null,
"alarmCode": "{410775B3-397C-634F-ADF3-34411861B2A3}",
"orgName": "根节点",
"alarmPosition": "asdsa",
"linkNames": null,
"pictures": null,
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"http://dfsd",
"taskWebUrl":"http://dfsd",
"taskAppUrl":"http://dfsd"
},
"code": "0",
"errMsg": ""
}
接口说明
报警事件分页查询接口
推荐每秒调用不超过15次
统计配了报警预案或报警类型为保存配置的事件记录
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.2.0
接口URL
/evo-apigw/evo-event/1.2.0/alarm-record/page
请求Method
POST
数据提交格式
application/json
请求参数
字段 | 说明 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
pageNum | 当前页 | int | 3 | Y | |
pageSize | 每页记录数 | int | 3 | Y | |
sort | 排序字段 | string | 32 | N | alarmDate,handleUser,handleDate,orgName,alarmPosition |
sortType | 排序方式 | string | 10 | N | ASC 升序 DESC 降序 |
alarmStat | 报警状态 | int | 1 | N | 1:报警产生,2:报警消失 |
handleStatList | 报警处理状态 | array | 51 | N | 1处理中,2已处理,3误报,4忽略,0未处理 |
orgCodeList | 所属组织编码 | array | 500 | N | |
nodeCodeList | 设备编码或通道编码 | array | 500 | N | |
alarmStartDateString | 报警开始时间 | string | 14 | N | 不传时间参数,表示查询当天凌晨到当前时间的数据,格式:yyyy-MM-dd HH:mm:ss |
alarmEndDateString | 报警结束时间 | string | 14 | N | 格式:yyyy-MM-dd HH:mm:ss |
handleStartDateString | 处理开始时间 | string | 14 | N | 格式:yyyy-MM-dd HH:mm:ss |
handleEndDateString | 处理结束时间 | string | 14 | N | 格式:yyyy-MM-dd HH:mm:ss |
alarmTypeList | 事件类型列表 | array | 500 | N | 枚举参考报警类型 |
alarmType | 事件类型 | int | 16 | N | 枚举参考报警类型 |
deviceCategory | 设备大类 | int | 3 | N | 枚举参考设备大类 |
isEvent | 报警预案标识 | int | 1 | N | 0:报警(配置报警预案),1:事件,设备或子系统上报的事件默认是1,配置报警预案后是0,空则查询报警与事件 |
alarmGradeList | 报警等级 | array | 3 | N | 枚举:1:严重;2:一般;3:轻微 |
language | 语言 | string | 32 | N | 不传从request里面拿,拿不到默认中文,中文:zh-cn |
dbType | 查询类型 | int | 1 | N | 0代表普通查询,1代表云数据库查询,1.0.1版本新增 |
请求参数示例
{
"pageNum":1,
"pageSize":10,
"sort":"alarmDate",
"sortType":"DESC",
"alarmStat":1,
"handleStatList":[1,2],
"orgCodeList":["001"],
"nodeCodeList":["1000000"],
"alarmStartDateString":"2019-10-18 00:00:00",
"alarmEndDateString":"2019-10-18 10:00:00",
"handleStartDateString":"2019-10-18 10:00:00",
"handleEndDateString":"2019-10-18 20:00:00",
"alarmType":1,
"deviceCategory":"1",
"language":"zh-cn",
"dbType":1
}
返回参数
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
success | 成功与否 | boolean | true:成功;false:失败 |
data | 结果项 | object | 成功时有此字段 |
pageData | 分页结果 | array | |
code | 错误码 | string | 前端根据错误国际化翻译 |
errMsg | 错误消息 | string | 错误消息 |
pageData对象
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
id | 数据库id | long | |
alarmDate | 报警发生时间 | string | 格式:yyyy-MM-dd HH:mm:ss |
alarmPosition | 报警发生地点 | string | |
alarmTypeName | 报警事件名称 | string | |
alarmType | 事件类型 | int | 枚举参考报警类型 |
orgName | 所属组织 | string | |
alarmStat | 报警状态 | int | 1:报警产生,2:报警消失 |
handleStat | 处理状态 | int | 1处理中,2已处理,3误报,4忽略,0未处理 |
handleUser | 处理人 | string | |
handleDate | 处理时间 | string | 格式:yyyy-MM-dd HH:mm:ss |
alarmCode | 报警编号 | string | |
linkNames | 联动能力 | string | |
alarmGrade | 报警等级 | int | 1:严重;2:一般;3:轻微 |
nodeCode | 报警源编码 | string | |
alarmPicture | 报警图片地址 | string | 图片相对地址,完整地址参考OSS方式 |
taskWebName | 任务详情 | string | 任务详情-供客户端使用 |
alarmWebUrl | 参数 | string | |
alarmAppUrl | 参数 | string | 空字符串 |
taskWebUrl | 参数 | string | |
taskAppUrl | 参数 | string | 空字符串 |
返回参数示例(成功)
{
"success": true,
"data": {
"pageData": [
{
"id": 199,
"alarmStat": 2,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:12:19",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{0996F5D2-2C46-2A4E-AFB6-446AD30E0B56}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 198,
"alarmStat": 1,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:11:46",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{249977A6-A5AA-114C-A712-03E8B7213BD8}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 197,
"alarmStat": 2,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:11:03",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{81B21DB1-4F00-CB40-9BE4-3FDAD194B642}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 196,
"alarmStat": 1,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:09:22",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{2098EB37-FF70-F547-8F56-F2EB4ED9975B}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 195,
"alarmStat": 2,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:08:07",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{9739A5CF-A9D2-714B-8E60-4A0EE7016BB8}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 194,
"alarmStat": 1,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:07:22",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{4A0F7110-57D3-9745-A340-11EBD0461F19}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 193,
"alarmStat": 2,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:06:45",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{C3408910-782F-6E43-B4CD-DDF84CDA9147}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 192,
"alarmStat": 1,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:06:15",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{2602053C-AB8D-5643-8A0F-2932F82043E9}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 191,
"alarmStat": 2,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:05:02",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{EBB6ECBE-C22D-0841-A310-4473005446F4}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
},
{
"id": 190,
"alarmStat": 2,
"alarmTypeName": "移动侦测",
"alarmDate": "2020-04-10 16:04:24",
"handleDate": "",
"handleStat": 0,
"alarmCode": "{530BB2E0-39F5-B740-B572-C2850B4B6080}",
"orgName": "根节点",
"alarmPosition": "10.35.163.67_视频通道_1",
"alarmGrade": 2,
"nodeCode": "1000012$1$0$0",
"alarmType": 3,
"isEvent": 1,
"alarmPicture": "",
"taskWebName":'任务详情',
"alarmWebUrl":"http://dfsd",
"alarmAppUrl":"",
"taskWebUrl":"http://dfsd",
"taskAppUrl":""
}
]
},
"code": "0",
"errMsg": ""
}
接口说明
alarm事件统计接口,大数据接口,请合理使用
推荐每秒调用一次
统计配了报警预案或报警类型为保存配置的事件记录
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-event/1.0.0/alarm-record/count-num
请求Method
POST
数据提交格式
application/json
请求参数
字段 | 说明 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
sort | 排序字段 | string | 32 | N | alarmDate,handleUser,handleDate,orgName,alarmPosition |
sortType | 排序方式 | string | 10 | N | ASC 升序 DESC 降序 |
alarmStat | 报警状态 | int | 1 | N | 1:报警产生,2:报警消失 |
handleStatList | 报警处理状态 | array | 5 | N | 1处理中,2已处理,3误报,4忽略,0未处理 |
orgCodeList | 所属组织编码 | array | 500 | N | 包含子组织编码 |
nodeCodeList | 设备编码或通道编码 | array | 500 | N | |
alarmStartDateString | 报警开始时间 | string | 14 | N | 不传时间参数,表示查询当天凌晨到当前时间的数据,格式:yyyy-MM-dd HH:mm:ss |
alarmEndDateString | 报警结束时间 | string | 14 | N | 格式:yyyy-MM-dd HH:mm:ss |
handleStartDateString | 处理开始时间 | string | 14 | N | 格式:yyyy-MM-dd HH:mm:ss |
handleEndDateString | 处理结束时间 | string | 14 | N | 格式:yyyy-MM-dd HH:mm:ss |
alarmTypeList | 事件类型列表 | array | 500 | N | 枚举参考报警类型 |
alarmType | 事件类型 | int | 16 | N | 枚举参考报警类型 |
deviceCategory | 设备大类 | int | 3 | N | 枚举参考设备大类 |
isEvent | 报警预案标识 | int | 1 | N | 0:报警(配置报警预案),1:事件,设备或子系统上报的事件默认是1,配置报警预案后是0,空则查询报警与事件 |
alarmGradeList | 报警等级 | array | 3 | N | 枚举:1:严重;2:一般;3:轻微 |
language | 语言 | string | 32 | N | 不传从request里面拿,拿不到默认中文,中文:zh-cn |
dbType | 查询类型 | int | 1 | N | 0代表普通查询,1代表云数据库查询,1.0.1版本新增 |
请求参数示例-统计某一天报警已处理总数
{
"handleStatList":[2],
"alarmStartDateString":"2022-09-01 00:00:00",
"alarmEndDateString":"2022-09-01 23:59:59",
"isEvent":"0",
"language":"zh-cn",
"dbType":1
}
请求参数示例-统计某一天报警未处理总数
{
"handleStatList":[0],
"alarmStartDateString":"2022-09-01 00:00:00",
"alarmEndDateString":"2022-09-01 23:59:59",
"isEvent":"0",
"language":"zh-cn",
"dbType":1
}
请求参数示例-统计报警与事件已处理总数
{
"handleStatList":[2],
"alarmStartDateString":"2022-09-01 00:00:00",
"alarmEndDateString":"2022-09-01 23:59:59"
}
请求参数示例-统计组织=001001下报警与事件未处理总数
{
"orgCodeList":["001001"],
"alarmStartDateString":"2022-09-01 00:00:00",
"alarmEndDateString":"2022-09-01 23:59:59"
}
返回参数
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
success | 成功与否 | boolean | true:成功;false:失败 |
code | 错误码 | string | 前端根据错误国际化翻译 |
errMsg | 错误消息 | string | 错误消息 |
data | 结果项 | TotalInfo | 成功时有此字段 |
TotalInfo
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
value | 报警数量 | int | 成功时返回 |
返回参数示例(成功)
{
"success": true,
"data": {
"value": 191
},
"code": "0",
"errMsg": ""
}